Predefined expression builders in the WebSphere Commerce portlet samples

The WebSphere Commerce portlet samples provide many predefined expression builders which can be reused to call WebSphere Commerce services. These expression builders are defined in the component-name/get-data-config.xml files.

The following tables contains the expression builders in the get-data-config.xml files, and provide the Fetch and Compose task implementations for your convenience:

Catalog

Expression builder name Fetch Task Command Implementation Compose Task Command Implementation Data type Expression builder Parameters
getMasterCatalog com.ibm.commerce.catalog.facade.server.commands.FetchCatalogByStoreIdCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogDetailsTaskCmdImpl Catalog {ibmwcf.ap=$accessProfile$}/Catalog[@primary='$booleanValue$']

>
accessProfile
WC_CatalogDetailsProfile
booleanValue
true
getAllCatalogs com.ibm.commerce.catalog.facade.server.commands.FetchCatalogByStoreIdCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogDetailsTaskCmdImpl Catalog {ibmwcf.ap=$accessProfile$}/Catalog[@primary='$booleanValue$']

>
accessProfile
WC_CatalogDetailsProfile
booleanValue
false
getCatalogDetailsByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogByCatalogIdCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogDetailsTaskCmdImpl Catalog {ibmwcf.ap=$accessProfile$}/Catalog[CatalogIdentifier[(UniqueID='$catalogId$')]]

>
accessProfile
WC_CatalogDetailsProfile
getCatalogDetailsByIdentifier com.ibm.commerce.catalog.facade.server.commands.FetchCatalogByIdentifierTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogDetailsTaskCmdImpl Catalog {ibmwcf.ap=$accessProfile$}/Catalog[CatalogIdentifier[ExternalIdentifier[Identifier='$catalogIdentifier$']]]

>
accessProfile
WC_CatalogDetailsProfile
getCatalogEntrySummaryByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByCatEntryIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntrySummaryTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[(UniqueID='$catEntryId$')]]

>
accessProfile
WC_CatalogEntrySummaryProfile
getCatalogEntryDetailsByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByCatEntryIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryDetailsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[(UniqueID='$catEntryId$')]]

>
accessProfile
WC_CatalogEntryDetailsProfile
getCatalogEntryMerchandisingAssociationsByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByCatEntryIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryMerchandisingAssociationsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[(UniqueID='$catEntryId$')]]

>
accessProfile
WC_CatalogEntryMerchandisingAssociationsProfile
getCatalogEntryComponentsByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByCatEntryIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryComponentsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[(UniqueID='$catEntryId$')]]

>
accessProfile
WC_CatalogEntryComponentsProfile
getCatalogEntrySummaryByPartNumber com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByPartNumberTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntrySummaryTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[(PartNumber='$partNumber$')]]

>
accessProfile
WC_CatalogEntrySummaryProfile
getCatalogEntryDetailsByPartNumber com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByPartNumberTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryDetailsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[(PartNumber='$partNumber$')]]

>
accessProfile
WC_CatalogEntryDetailsProfile
getCatalogEntryMerchandisingAssociationsByPartNumber com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByPartNumberTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryMerchandisingAssociationsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[(PartNumber='$partNumber$')]]

>
accessProfile
WC_CatalogEntryMerchandisingAssociationsProfile
getCatalogEntryComponentsByPartNumber com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryByPartNumberTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryComponentsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[(PartNumber='$partNumber$')]]

>
accessProfile
WC_CatalogEntryComponentsProfile
findCatalogEntriesSummaryByPartNumber com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryBySearchTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntrySummaryTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$;wc_nameOp=$nameOp$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[contains(@PartNumber,'$partNumber$')]]]

>
accessProfile
WC_CatalogEntrySummaryProfile
findCatalogEntriesDetailsByPartNumber com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryBySearchTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryDetailsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$;wc_nameOp=$nameOp$}/CatalogEntry[CatalogEntryIdentifier[ExternalIdentifier[contains(@PartNumber,'$partNumber$')]]]

>
accessProfile
WC_CatalogEntryDetailsProfile
findCatalogEntriesSummaryByName com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryBySearchTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntrySummaryTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$;wc_nameOp=$nameOp$;wc_searchTermScope=$searchTermScope$}/CatalogEntry[Description[contains(@Name,'$name$')]]

>
accessProfile
WC_CatalogEntrySummaryProfile
searchTermScope
2
findCatalogEntriesDetailsByName com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryBySearchTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryDetailsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$;wc_nameOp=$nameOp$;wc_searchTermScope=$searchTermScope$}/CatalogEntry[Description[contains(@Name,'$name$')]]

>
accessProfile
WC_CatalogEntryDetailsProfile
searchTermScope
2
findCatalogEntriesSummaryByDescription com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryBySearchTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntrySummaryTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$;wc_nameOp=$nameOp$;wc_searchTermScope=$searchTermScope$}/CatalogEntry[Description[contains(@ShortDescription,'$description$')]]

>
accessProfile
WC_CatalogEntrySummaryProfile
searchTermScope
1
findCatalogEntriesDetailsByDescription com.ibm.commerce.catalog.facade.server.commands.FetchCatalogEntryBySearchTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogEntryDetailsTaskCmdImpl CatalogEntry {ibmwcf.ap=$accessProfile$;wc_nameOp=$nameOp$;wc_searchTermScope=$searchTermScope$}/CatalogEntry[Description[contains(@ShortDescription,'$description$')]]

>
accessProfile
WC_CatalogEntryDetailsProfile
searchTermScope
1
getCatalogGroupSummaryByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupSummaryTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]

>
accessProfile
WC_CatalogGroupSummaryProfile
getCatalogGroupDetailsByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupDetailsTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]

>
accessProfile
WC_CatalogGroupDetailsProfile
getCatalogGroupMerchandisingAssociationsByID com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]

>
accessProfile
WC_CatalogGroupMerchandisingAssociationsProfile
getCatalogGroupSummaryByIdentifier com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdentifierTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupSummaryTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[ExternalIdentifier[GroupIdentifier='$catGroupIdentifier$']]]

>
accessProfile
WC_CatalogGroupSummaryProfile
getCatalogGroupDetailsByIdentifier com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdentifierTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupDetailsTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[ExternalIdentifier[GroupIdentifier='$catGroupIdentifier$']]]

>
accessProfile
WC_CatalogGroupDetailsProfile
getCatalogGroupMerchandisingAssociationsByIdentifier com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdentifierTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[ExternalIdentifier[GroupIdentifier='$catGroupIdentifier$']]]

>
accessProfile
WC_CatalogGroupMerchandisingAssociationsProfile
getTopCategories com.ibm.commerce.catalog.facade.server.commands.FetchTopCategoriesTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeTopCategoriesTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[@topCatalogGroup='$booleanValue$']

>
accessProfile
WC_CatalogGroupTopCategoriesProfile
booleanValue
true
getCategoryWithChildrenCategories com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupCatalogGroupChildrenTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]

>
accessProfile
WC_CatalogGroupCatalogGroupChildrenProfile
getCategoryWithChildrenCatalogEntries com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupCatalogEntryChildrenTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]

>
accessProfile
WC_CatalogGroupCatalogEntryChildrenProfile
getCategoryWithAllChildren com.ibm.commerce.catalog.facade.server.commands.FetchCatalogGroupByIdTaskCmdImpl com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupAllChildrenTaskCmdImpl CatalogGroup {ibmwcf.ap=$accessProfile$}/CatalogGroup[CatalogGroupIdentifier[UniqueID='$catGroupId$']]

>
accessProfile
WC_CatalogGroupAllChildrenProfile

Order

Expression builder name Fetch Task Command Implementation Compose Task Command Implementation Data type Expression Default Parameters
findCurrentShoppingCart com.ibm.commerce.order.facade.server.commands.FetchOrdersByExtParameterCmdImpl com.ibm.commerce.order.facade.server.commands.ComposeOrderSummaryCmdImpl Order {ibmwcf.ap=$accessProfile$;ibmord.isCurrentShoppingCart='$isCurrentShoppingCart$'}/Order

>
accessProfile
WC_OrderSummaryProfile
isCurrentShoppingCart
true
findByOrderStatus com.ibm.commerce.order.facade.server.commands.FetchOrdersByStatusCmdImpl com.ibm.commerce.order.facade.server.commands.ComposeOrderSummaryCmdImpl Order {ibmwcf.ap=$accessProfile$}/Order[OrderStatus[(Status='$status$')]]

>
accessProfile
WC_OrderSummaryProfile
findByOrderId com.ibm.commerce.order.facade.server.commands.FetchOrdersByIdentifierCmdImpl com.ibm.commerce.order.facade.server.commands.ComposeOrderSummaryCmdImpl Order {ibmwcf.ap=$accessProfile$}/Order[OrderIdentifier[(UniqueID='$orderId$')]]

>
accessProfile
WC_OrderSummaryProfile
findByOrderId com.ibm.commerce.order.facade.server.commands.FetchOrdersByIdentifierCmdImpl com.ibm.commerce.order.facade.server.commands.ComposeUsableShippingInformationCmdImpl Order {ibmwcf.ap=$accessProfile$}/Order[OrderIdentifier[(UniqueID='$orderId$')]]

>
accessProfile
WC_UsableShippingInfoProfile
findByOrderId com.ibm.commerce.order.facade.server.commands.FetchOrdersByIdentifierCmdImpl com.ibm.commerce.order.facade.server.commands.ComposeUsablePaymentInformationCmdImpl Order {ibmwcf.ap=$accessProfile$}/Order[OrderIdentifier[(UniqueID='$orderId$')]]

>
accessProfile
WC_UsablePaymentInfoProfile

Member

Expression builder name Fetch Task Command Implementation Compose Task Command Implementation Data type Expression builder Parameters
findCurrentPerson com.ibm.commerce.member.facade.server.commands.FetchPersonCmdImpl com.ibm.commerce.member.facade.server.commands.ComposePersonFromDataBeanAllCmdImpl Person {self=true;ibmwcf.ap=$accessProfile$}/Person

>
accessProfile
All
findByUniqueId com.ibm.commerce.member.facade.server.commands.FetchPersonCmdImpl com.ibm.commerce.member.facade.server.commands.ComposePersonFromDataBeanAllCmdImpl Person {ibmwcf.ap=$accessProfile$}/Person[PersonIdentifier[(UniqueId='$personId$')]]

>
accessProfile
All
findByDistinguishedName com.ibm.commerce.member.facade.server.commands.FetchPersonCmdImpl com.ibm.commerce.member.facade.server.commands.ComposePersonFromDataBeanAllCmdImpl Person {ibmwcf.ap=$accessProfile$}/Person[PersonIdentifier[(DistinguishedName='$distinguishedName$')]]

>
accessProfile
All


Related concepts

WebSphere Commerce services WebSphere Commerce services functional architecture Design patterns Design pattern for Get service implementation


Related tasks

Create a new search expression


Related reference

Tag: getData GetData tag configuration - - -