Share via

Commerce Foundation ContentSelectorCollection CommerceQuery

  • Article

This operation allows you to batch together several ContentSelector queries into a single operation, allowing you to create a single query operation that selects multiple ContentSelector objects, where each is potentially retrieved using different targeting information. When a ConentSelectorCollection query is processed, the framework automatically ensures the operation does not select duplicate advertisements, so there is no need to provide PageHistory in the search criteria.

Syntax

        var queryContentSelectorCollection = new CommerceQuery<CommerceEntity>("ContentSelectorCollection");

Parameters

At a minimum, the caller must specify the ContentSelectorCollection to be retrieved. This operation supports only CommerceModelSearch criteria mechanism only.

Operation Sequence Components

Operation Sequence Component

Description

ContentSelectorCollectionLoader

This component is responsible for populating the ContentSelectors relationship list and ensuring that no child ContentSelector objects contain duplicate advertisements.

Related Operation

Description

CommerceQueryRelatedItem<ContentSelector> (ContentSelectors)

Use to retrieve the ContentSelectors related to a ContentSelectorCollection as part of a CommerceQuery<ContentSelectorCollection> operation.

CommerceQueryRelatedItem<Advertisement> (Advertisements)

Use to retrieve the advertisement related to a ContentSelector as part of a CommerceQuery<ContentSelector> operation. This operation must be related to the CommerceQueryRelatedItem<ContentSelector>(ContentSelectors) operation.

Valid Query Operations

Property

Description

FirstItemIndex

If this is anything other than Null or 0 (zero), no items will be returned from the query because exactly 1 (one) item is always returned.

Model

This must have the model name ContentSelectorCollection. The following table lists the properties for the ContentSelectorCollection that the search supports:

PropertyUsage
ContentSelectorsOptional.
CampaignHistoryOptional.

Return Value

This query returns a CommerceQueryOperationResponse containing one ContentSelectorCollection commerce entity whose Advertisements relationship list contains the targeted advertisement selected.

Exceptions

Microsoft Multi-Channel Commerce Foundation can throw the following exception during this operation:

  • FaultException<GeneralOperationFault>

See Also

Other Resources

Commerce Foundation ContentSelectorCollection

CommerceQuery