Get all catalog details

This service request, getAllCatalogs, returns details on all catalogs, details include the owner ID, catalog name, thumbnail and full-size image path, short and long description.

Request

Request BOD	GetCatalog business object document (BOD).
Access profile	WC_CatalogDetailsProfile
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetCatalog.xsd
Service data object	com.ibm.commerce.catalog.facade.datatypes.GetCatalogType

Sample request BOD

<_cat:GetCatalog
       
xmlns:_cat="http://www.ibm.com/xmlns/prod/commerce/9/catalog"
       
xmlns:_wcf="http://www.ibm.com/xmlns/prod/commerce/9/foundation"
        xmlns:oa="http://www.openapplications.org/oagis/9"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <oa:ApplicationArea
xsi:type="_wcf:ApplicationAreaType">
                <oa:CreationDateTime>
                        2007-01-25T14:28:39.840Z
                </oa:CreationDateTime>
               
<oa:BODID>420c9420-acaa-11db-b8e8-832d45b904e7</oa:BODID>
                <_wcf:BusinessContext>
                        <_wcf:ContextData
name="storeId">10101</_wcf:ContextData>
                </_wcf:BusinessContext>
        </oa:ApplicationArea>
        <_cat:DataArea>
                <oa:Get>
                        <oa:Expression
expressionLanguage="wcf:XPath">
                               
{_wcf.ap=WC_CatalogDetailsProfile}/Catalog[@primary='false']
                        </oa:Expression>
                </oa:Get>
        </_cat:DataArea>
</_cat:GetCatalog>

Response

Response BOD	ShowCatalogType
Schema	/Catalog-DataObjects/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/ShowCatalog.xsd
Service data object	com.ibm.commerce.catalog.facade.datatypes.ShowCatalogType

The response based on access profile WC_CatalogDetailsProfile contains the following information:

/Catalog/@primary
/Catalog/CatalogIdentifier/UniqueID
/Catalog/CatalogIdentifier/ExternalIdentifier/@ownerID
/Catalog/CatalogIdentifier/ExternalIdentifier/Identifier
/Catalog/CatalogDescription/@language
/Catalog/CatalogDescription/Name
/Catalog/CatalogDescription/ThumbNail
/Catalog/CatalogDescription/FullImage
/Catalog/CatalogDescription/ShortDescription
/Catalog/CatalogDescription/LongDescription

Sample response BOD

<_cat:ShowCatalog
xmlns:Oagis9="http://www.openapplications.org/oagis/9"
       
xmlns:_cat="http://www.ibm.com/xmlns/prod/commerce/9/catalog"
       
xmlns:_wcf="http://www.ibm.com/xmlns/prod/commerce/9/foundation"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <Oagis9:ApplicationArea
xsi:type="_wcf:ApplicationAreaType">
                <Oagis9:CreationDateTime>
                        2007-01-25T14:28:41.062Z
                </Oagis9:CreationDateTime>
                <Oagis9:BODID>
                        4319be60-acaa-11db-83a9-832d45b8fe37
                </Oagis9:BODID>
        </Oagis9:ApplicationArea>
        <_cat:DataArea>
                <_cat:Catalog primary="true">
                        <_cat:CatalogIdentifier>
                               
<_wcf:UniqueID>10101</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000101">
                                       
<_wcf:Identifier>ConsumerDirect</_wcf:Identifier>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogIdentifier>
                        <_cat:Description language="-1">
                                <_cat:Name>Store master
catalog</_cat:Name>
                                <_cat:LongDescription>
                                        Visit the largest online
retail store of apparel.
                                        Shop the wide selection in
activewear, jeans,
                                        pants, shorts and
accessories for men and women.
                                </_cat:LongDescription>
                        </_cat:Description>
                </_cat:Catalog>
                <_cat:Catalog primary="false">
                        <_cat:CatalogIdentifier>
                               
<_wcf:UniqueID>10151</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000101">
                                        <_wcf:Identifier>
                                                ConsumerDirect
Sales Catalog
                                        </_wcf:Identifier>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogIdentifier>
                        <_cat:Description language="-1">
                                <_cat:Name>Chef's
Delight</_cat:Name>
                                <_cat:ShortDescription>
                                        Handy kitchenware items at
fantastic prices.
                                </_cat:ShortDescription>
                        </_cat:Description>
                </_cat:Catalog>
        </_cat:DataArea>
</_cat:ShowCatalog>

Usage

To use this service request on a JSP page use the expression-builder, getAllCatalogs.

The expression-builder maps to the following XPath expression:

{_wcf.ap=$accessProfile$}/Catalog[@primary='$booleanValue$']

The defaults are the following values:

accessProfile= WC_CatalogDetailsProfile
booleanValue=false

This service request uses the
CatalogDataBean data bean.

Exceptions

If there is an error the error is reported in the Response message. You can see the error details in the trace log, SystemOut.log.

Customization

The following extensions are supported:

Create your own implementation of the interface
ComposeCatalogTaskCmd. By creating your own implementation of the
ComposeCatalogTaskCmd, and an access profile, you can control the information returned by the service.

Related Reference

WebSphere Commerce foundation tag library