Get master catalog details

This service request, getMasterCatalog, returns the master catalog for a store based on the store ID. The response displays details such as the name, short and long description, and image paths for the master catalog.

 

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:27:43.209Z
                </oa:CreationDateTime>
               
<oa:BODID>207ccff0-acaa-11db-b424-832d45b904ad</oa:BODID>
                <_wcf:BusinessContext>
                        <_wcf:ContextData
name="storeId">10001</_wcf:ContextData>
                </_wcf:BusinessContext>
        </oa:ApplicationArea>
        <_cat:DataArea>
                <oa:Get>
                        <oa:Expression
expressionLanguage="wcf:XPath">
                               
{ibmwcf.ap=WC_CatalogDetailsProfile}/Catalog[@primary='true']
                        </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 contains the following information:

/Catalog/@primary
/Catalog/CatalogIdentifier//UniqueID
/Catalog/CatalogIdentifier/ExternalIdentifier/@ownerID
/Catalog/CatalogIdentifier/ExternalIdentifier/@ownerID/Identifier
/Catalog/CatalogDescription/@language/Name
/Catalog/CatalogDescription/@language/ThumbNail
/Catalog/CatalogDescription/@language/FullImage
/Catalog/CatalogDescription/@language/ShortDescription
/Catalog/CatalogDescription/@language/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:27:43.329Z
                </Oagis9:CreationDateTime>
                <Oagis9:BODID>
                        20b06310-acaa-11db-83a9-832d45b8fe37
                </Oagis9:BODID>
        </Oagis9:ApplicationArea>
        <_cat:DataArea>
                <_cat:Catalog primary="true">
                        <_cat:CatalogIdentifier>
                               
<_wcf:UniqueID>10001</_wcf:UniqueID>
                                <_wcf:ExternalIdentifier
                                       
ownerID="7000000000000000002">
                                       
<_wcf:Identifier>AdvancedB2BDirect</_wcf:Identifier>
                                </_wcf:ExternalIdentifier>
                        </_cat:CatalogIdentifier>
                        <_cat:Description language="-1">
                                <_cat:Name>Store master
catalog</_cat:Name>
                                <_cat:LongDescription>
                                        Largest auto parts retailer
in the country. Our
                                        catalog cater to
do-it-yourself mechanics, as
                                        well as professional auto
shops. We sell all kinds
                                        of auto parts including a
large variety of brake
                                        pads, suspensions,
transmissions, electrical
                                        systems, entertainment
systems, batteries, lamps,
                                        starters, audio systems,
video systems, GPS
                                        navigation systems,
cylinders, tires, shocks,
                                        bearing, springs, clutches,
gears, differentials,
                                        and more.
                                </_cat:LongDescription>
                        </_cat:Description>
                </_cat:Catalog>
        </_cat:DataArea>
</_cat:ShowCatalog>

 

Usage

To use this service request on a JSP page use the expression-builder, getMasterCatalog. This maps to the following XPath expression:

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

This service request uses the
CatalogDataBean data bean.

The storeId needs to be provided in the business context.

The defaults are:

• accessProfile=WC_CatalogDetailsProfile

• booleanValue=true

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 concepts

../../com.ibm.commerce.business_process.doc/concepts/processFind_product_(ConsumerDirect).htm
Design pattern for Get service implementation
Master catalog

Related Reference

WebSphere Commerce foundation tag library