Retrieve the collection that is being loaded as part of processing this result set.

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

Syntax

C#
public IPersistentCollection GetLoadingCollection(
	ICollectionPersister persister,
	Object key
)
Visual Basic
Public Function GetLoadingCollection ( _
	persister As ICollectionPersister, _
	key As Object _
) As IPersistentCollection
Visual C++
public:
IPersistentCollection^ GetLoadingCollection(
	ICollectionPersister^ persister, 
	Object^ key
)

Parameters

persister
Type: NHibernate.Persister.Collection..::..ICollectionPersister
The persister for the collection being requested.
key
Type: System..::..Object
The key of the collection being requested.

Return Value

The loading collection (see discussion above).

Remarks

Basically, there are two valid return values from this method:
  • an instance of {@link PersistentCollection} which indicates to continue loading the result set row data into that returned collection instance; this may be either an instance already associated and in the midst of being loaded, or a newly instantiated instance as a matching associated collection was not found.
  • null indicates to ignore the corresponding result set row data relating to the requested collection; this indicates that either the collection was found to already be associated with the persistence context in a fully loaded state, or it was found in a loading state associated with another result set processing context.

See Also