IEntity.FindAssociatedMultiple Method (IList<EntityInstanceCollection>, IAssociation, IFilterCollection, ILobSystemInstance, OperationMode)

Gets the external items that are associated to the given source external items by applying a specified filter collection and using the specified mode of operation.

Namespace:  Microsoft.BusinessData.MetadataModel
Assembly:  Microsoft.BusinessData (in Microsoft.BusinessData.dll)

Syntax

'Declaration
Function FindAssociatedMultiple ( _
    sourceEntityInstances As IList(Of EntityInstanceCollection), _
    association As IAssociation, _
    filterCollection As IFilterCollection, _
    lobSystemInstance As ILobSystemInstance, _
    mode As OperationMode _
) As IEntityInstanceEnumerator
'Usage
Dim instance As IEntity
Dim sourceEntityInstances As IList(Of EntityInstanceCollection)
Dim association As IAssociation
Dim filterCollection As IFilterCollection
Dim lobSystemInstance As ILobSystemInstance
Dim mode As OperationMode
Dim returnValue As IEntityInstanceEnumerator

returnValue = instance.FindAssociatedMultiple(sourceEntityInstances, _
    association, filterCollection, lobSystemInstance, _
    mode)
IEntityInstanceEnumerator FindAssociatedMultiple(
    IList<EntityInstanceCollection> sourceEntityInstances,
    IAssociation association,
    IFilterCollection filterCollection,
    ILobSystemInstance lobSystemInstance,
    OperationMode mode
)

Parameters

Return Value

Type: Microsoft.BusinessData.Runtime.IEntityInstanceEnumerator
The external items that are associated to the given source external items.

Remarks

The association provided as an input to this method must be a BulkAssociationNavigator. FindAssociatedMultiple requires a list of collections of external items, where each collection contains an external item for every source external content type of the BulkAssociationNavigator. This function will return external items based on the destination external content type of the AssociationNavigator that are associated with external items in any of the given collections.

This method can potentially return a lot of external items. IFilterCollection can be specified to filter the results and optimize the behavior. For more information about how to use fillers, see IFilterCollection.

This method returns an IEntityInstanceEnumerator, which requires special clean up and may expose additional functionality to control the behavior when the external system returns data in batches. For more information about how to use external item enumerators, see IEntityInstanceEnumerator.

The mode of operation can be specified for this method. For more information about how to use operation modes, see OperationMode.

Instances of objects in the Business Data Connectivity object model are tied to the Metadata Store they are obtained from. Using instances tied to one Metadata Store with the instances from another Metadata Store will cause data corruption and other unexpected behavior. For more information, see DatabaseBackedMetadataCatalog, FileBackedMetadataCatalog, and RemoteSharedFileBackedMetadataCatalog.

See Also

Reference

IEntity Interface

IEntity Members

FindAssociatedMultiple Overload

Microsoft.BusinessData.MetadataModel Namespace