Get a batch of uninitialized collection keys for a given role

Namespace: NHibernate.Engine
Assembly: NHibernate (in NHibernate.dll) Version: 3.2.0.4000 (3.2.0.4000)

Syntax

C#
public Object[] GetCollectionBatch(
	ICollectionPersister collectionPersister,
	Object id,
	int batchSize,
	EntityMode entityMode
)
Visual Basic
Public Function GetCollectionBatch ( _
	collectionPersister As ICollectionPersister, _
	id As Object, _
	batchSize As Integer, _
	entityMode As EntityMode _
) As Object()
Visual C++
public:
array<Object^>^ GetCollectionBatch(
	ICollectionPersister^ collectionPersister, 
	Object^ id, 
	int batchSize, 
	EntityMode entityMode
)

Parameters

collectionPersister
Type: NHibernate.Persister.Collection..::..ICollectionPersister
The persister for the collection role.
id
Type: System..::..Object
A key that must be included in the batch fetch
batchSize
Type: System..::..Int32
the maximum number of keys to return
entityMode
Type: NHibernate..::..EntityMode
The entity mode.

Return Value

an array of collection keys, of length batchSize (padded with nulls)

See Also