Share via

Implementing an AssociationNavigator

  • Article

Applies to: SharePoint Server 2010

In this article
Description
Syntax
Remarks
Examples

Description

An AssociationNavigator method instance enables you to get external items that are related to given external items, from the external system. This stereotype enables an association in Microsoft Business Connectivity Services (BCS). For example, given a business object named Customer, this stereotype can be used to get all the related orders of that customer.

Syntax

Following are the typical method signatures for AssociationNavigator methods:

DestinationEntityDataType[] FindAssociated(sourceId1Type id1, ...)
DestinationEntityDataType FindAssociated(sourceId1Type id1, ...)

Remarks

To qualify as an AssociationNavigator, the corresponding method should:

  • Take an item as input for every source external content type of the AssociationNavigator.

  • Return an IEntityInstanceEnumerator that contains the external items that are associated with the given external items, that are based on the destination external content type.

Note

We recommend that the method provide rich filtering, especially if it returns many external items. For more information about how to use filters, see IFilterCollection.

Examples

Code Snippet: Implementing an AssociationNavigator

See Also

Concepts

XML Snippet: Modeling an AssociationNavigator Method

Code Snippet: Execute the AssociationNavigator Method Instance of an External Content Type

Code Snippet: Execute the AssociationNavigator Method Instance of an External Content Type for an Association Without a Foreign Key