AbstractEntityInstance.GetAssociatedInstances Method (Association, FilterCollection)

When overridden in a derived class, gets a filtered set of associated entity instances for this entity instance for the specified association.

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Runtime
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
Public Overridable Function GetAssociatedInstances ( _
    association As Association, _
    filters As FilterCollection _
) As IEntityInstanceEnumerator

'Usage
Dim instance As AbstractEntityInstance
Dim association As Association
Dim filters As FilterCollection
Dim returnValue As IEntityInstanceEnumerator

returnValue = instance.GetAssociatedInstances(association, _
    filters)

public virtual IEntityInstanceEnumerator GetAssociatedInstances(
    Association association,
    FilterCollection filters
)

Parameters

• association
  Type: Microsoft.Office.Server.ApplicationRegistry.MetadataModel.Association
  A valid Association object for this entity.

• filters
  Type: Microsoft.Office.Server.ApplicationRegistry.Runtime.FilterCollection
  A valid FilterDescriptionCollection object with the filters to apply to the result set of the association method.

Return Value

Type: Microsoft.Office.Server.ApplicationRegistry.Runtime.IEntityInstanceEnumerator
An IEntityInstanceEnumerator containing the filtered related entity instances for this entity instance.

Implements

IEntityInstance.GetAssociatedInstances(Association, FilterCollection)

Remarks

All Business Data Catalog associations are 1 to many. Therefore, what comes back is always a stream of 0 or more entity instances, and this can be optionally filtered.

See Also

Reference

AbstractEntityInstance Class

AbstractEntityInstance Members

GetAssociatedInstances Overload

Microsoft.Office.Server.ApplicationRegistry.Runtime Namespace