com.ibm.commerce.catalog.facade.client

Class CatalogFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.catalog.facade.client.AbstractCatalogFacadeClient

com.ibm.commerce.catalog.facade.client.CatalogFacadeClient

public class CatalogFacadeClient
extends AbstractCatalogFacadeClient

This class provides common methods that this and other utility class to the Catalog facade can use. This class also provides a set of convenient Java API to represent particular Catalog operations. This set of Java API also include APIs for Web based requests to transform the name value pair request into the appropriate request documents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROCESS_VERB_ACTION_ADD The process verb constant to represents the action of Add.
static java.lang.String	PROCESS_VERB_ACTION_CREATE The process verb constant to represents the action of Create.
static java.lang.String	PROCESS_VERB_ACTION_DELETE The process verb constant to represents the action of Add.

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
CatalogFacadeClient() Creates an instance of the client to communicate with the Catalog facade.
CatalogFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the Catalog facade.

Method Summary

Modifier and Type	Method and Description
RespondCatalogDataAreaType	changeCatalog(java.lang.String[] action, CatalogType[] catEntries, java.lang.String[] expression) This method changes the catalog entry.
java.util.Map	changeSalesCatalog(java.util.Map parameters) This method transforms the specified parameter input into the request document to represent the sales catalog create operation.
java.util.Map	changeSalesCatalogDescription(java.util.Map parameters) Change the sales catalog description in a specified langauge.
AcknowledgeCatalogDataAreaType	createCatalog(java.util.List catalogEntryList) This method builds and sends the request to create catalog entries.
CatalogType	createCatalogDataObject(CatalogIdentifierType catEntryId) This method creates an instance of CatalogType object with the given catalog entry id.
java.util.Map	createSalesCatalog(java.util.Map parameters) This method transforms the specified parameter input into the request document to represent the sales catalog create operation.
java.util.Map	createSalesCatalogDescription(java.util.Map parameters) This method transforms the specified parameter input into the request document to represent the sales catalog create operation.
AcknowledgeCatalogDataAreaType	deleteCatalog(CatalogIdentifierType[] catGroupIds) This method deletes the catalog Group.
java.util.Map	deleteSalesCatalog(java.util.Map parameters) This method transforms the specified parameter input into the request document to represent the sales catalog delete operation.
java.util.List	fetchCatalog(java.lang.String xPath) This method is used to pass the get catalog BOD, and return the SHOW catalog BOD.
java.util.Hashtable	getCatalogEntryWithPaging(java.lang.String expressionLanguage, java.lang.String expression, java.lang.String maxItems, java.lang.String refId, java.lang.String startNum) This method provides support for paging.
java.util.Hashtable	getCatalogGroupWithPaging(java.lang.String expressionLanguage, java.lang.String expression, java.lang.String maxItems, java.lang.String refId, java.lang.String startNum) This method provides support for paging.
AcknowledgeCatalogDataAreaType	processCatalog(java.lang.String[] actionArray, CatalogType[] catentries, java.lang.String[] strXPaths) This method process the catalog entry.
RespondCatalogDataAreaType	updateCatalogAttribute(CatalogIdentifierType[] catEntryIds, java.util.Map[] attributes) Update catalog attribute
RespondCatalogDataAreaType	updateCatalogDescription(CatalogIdentifierType[] catEntryIds, CatalogDescriptionType[] catEntryDescs) RespondCatalogDataAreaType
RespondCatalogDataAreaType	updateCatalogDescription(CatalogIdentifierType catEntryId, CatalogDescriptionType[] catEntryDescs) RespondCatalogDataAreaType
RespondCatalogDataAreaType	updateCatalogDescription(CatalogType[] catalogs) This method updates multiple catalog descriptions of a single catalog .
RespondCatalogDataAreaType	updateCatalogIdentifier(CatalogIdentifierType[] catEntryIds) Update catalog identifier

Methods inherited from class com.ibm.commerce.catalog.facade.client.AbstractCatalogFacadeClient

changeAttributeDictionary, changeAttributeDictionaryAttribute, changeAttributeDictionaryAttributeGroup, changeCatalog, changeCatalogEntry, changeCatalogFilter, changeCatalogGroup, getAttributeDictionary, getAttributeDictionary, getAttributeDictionary, getAttributeDictionaryAttribute, getAttributeDictionaryAttribute, getAttributeDictionaryAttribute, getAttributeDictionaryAttributeGroup, getAttributeDictionaryAttributeGroup, getAttributeDictionaryAttributeGroup, getCatalog, getCatalog, getCatalog, getCatalogEntry, getCatalogEntry, getCatalogEntry, getCatalogEntryFiltering, getCatalogEntryFiltering, getCatalogEntryFiltering, getCatalogFilter, getCatalogFilter, getCatalogFilter, getCatalogGroup, getCatalogGroup, getCatalogGroup, getCatalogNavigationView, getCatalogNavigationView, getCatalogNavigationView, getKit, getKit, getKit, processAttributeDictionary, processAttributeDictionaryAttribute, processAttributeDictionaryAttributeGroup, processCatalog, processCatalogEntry, processCatalogFilter, processCatalogGroup

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROCESS_VERB_ACTION_ADD

public static final java.lang.String PROCESS_VERB_ACTION_ADD

The process verb constant to represents the action of Add.

See Also:

Constant Field Values

PROCESS_VERB_ACTION_CREATE

public static final java.lang.String PROCESS_VERB_ACTION_CREATE

The process verb constant to represents the action of Create.

See Also:

Constant Field Values

PROCESS_VERB_ACTION_DELETE

public static final java.lang.String PROCESS_VERB_ACTION_DELETE

The process verb constant to represents the action of Add.

See Also:

Constant Field Values

Constructor Detail

CatalogFacadeClient

public CatalogFacadeClient()

Creates an instance of the client to communicate with the Catalog facade.

CatalogFacadeClient

public CatalogFacadeClient(BusinessContextType businessContext,
                           javax.security.auth.callback.CallbackHandler callbackHandler)

Creates an instance of the client to communicate with the Catalog facade.

Parameters:

businessContext - The default business context to associate with the messages when making requests.

callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

fetchCatalog

public java.util.List fetchCatalog(java.lang.String xPath)
                            throws CatalogException

This method is used to pass the get catalog BOD, and return the SHOW catalog BOD.

Parameters:

xPath - The XPath for the get.

Returns:

A list of Catalogs , with the information peartaining to each catalog.

Throws:

CatalogException

createSalesCatalog

public java.util.Map createSalesCatalog(java.util.Map parameters)
                                 throws CatalogException

This method transforms the specified parameter input into the request document to represent the sales catalog create operation. This method expects the following parameter keys and associates them them as the following.

• -- insert keys and how it is transformed here --

Parameters:

parameters - : list of parameters.

Returns:

Map of result parameters such as catalogId

Throws:

CatalogException

changeSalesCatalog

public java.util.Map changeSalesCatalog(java.util.Map parameters)
                                 throws CatalogException

This method transforms the specified parameter input into the request document to represent the sales catalog create operation. This method expects the following parameter keys and associates them them as the following.

• -- insert keys and how it is transformed here --

Parameters:

parameters - : Map of input parameters.

Returns:

Map of result parameters such as catalogId

Throws:

CatalogException

changeSalesCatalogDescription

public java.util.Map changeSalesCatalogDescription(java.util.Map parameters)
                                            throws CatalogException

Change the sales catalog description in a specified langauge.

Parameters:

parameters - : A map of input parameters.

Returns:

Map of result parameters such as the catalogId of the description that was updated.

Throws:

CatalogException

createSalesCatalogDescription

public java.util.Map createSalesCatalogDescription(java.util.Map parameters)
                                            throws CatalogException

This method transforms the specified parameter input into the request document to represent the sales catalog create operation. This method expects the following parameter keys and associates them them as the following.

• -- insert keys and how it is transformed here --

Parameters:

parameters - : Map of input parameters.

Returns:

Map of result parameters such as catalogId

Throws:

CatalogException

deleteSalesCatalog

public java.util.Map deleteSalesCatalog(java.util.Map parameters)
                                 throws CatalogException

This method transforms the specified parameter input into the request document to represent the sales catalog delete operation. This method expects the following parameter keys and associates them them as the following.

• -- insert keys and how it is transformed here --

Parameters:

parameters - : Map of input parameters.

Returns:

Map of result parameters such as catalogId

Throws:

CatalogException

createCatalog

public AcknowledgeCatalogDataAreaType createCatalog(java.util.List catalogEntryList)
                                             throws CatalogException

This method builds and sends the request to create catalog entries. The catalog entries that need to be created are passed as a list of CatalogType objects containg the all teh information related to the catentry.

Parameters:

catalogEntryList - a list of CatalogType objects to be created.

Returns:

the AcknowledgeCatalogDataAreaType

Throws:

CatalogException

processCatalog

public AcknowledgeCatalogDataAreaType processCatalog(java.lang.String[] actionArray,
                                                     CatalogType[] catentries,
                                                     java.lang.String[] strXPaths)
                                              throws CatalogException

This method process the catalog entry.

Parameters:

actionArray - the action to be applied to the catalog entry.

catentries - the catalog entry to be changed.

strXPaths - the expression corresponding to each action in the list.

Returns:

The AcknowledgeCatalogDataAreaType that contains the catalog entry .

Throws:

CatalogException

deleteCatalog

public AcknowledgeCatalogDataAreaType deleteCatalog(CatalogIdentifierType[] catGroupIds)
                                             throws CatalogException

This method deletes the catalog Group.

Parameters:

catGroupIds - The ids of the catalog Group to be deleted.

Returns:

The AcknowledgeCatalogDataAreaType that contains the catalog Group id and the created catalog Group.

Throws:

CatalogException

updateCatalogDescription

public RespondCatalogDataAreaType updateCatalogDescription(CatalogIdentifierType[] catEntryIds,
                                                           CatalogDescriptionType[] catEntryDescs)
                                                    throws CatalogException

RespondCatalogDataAreaType

Parameters:

catEntryIds -

catEntryDescs -

Returns:

RespondCatalogDataAreaType

Throws:

CatalogException

updateCatalogIdentifier

public RespondCatalogDataAreaType updateCatalogIdentifier(CatalogIdentifierType[] catEntryIds)
                                                   throws CatalogException

Update catalog identifier

Parameters:

catEntryIds -

Returns:

RespondCatalogDataAreaType

Throws:

CatalogException

updateCatalogAttribute

public RespondCatalogDataAreaType updateCatalogAttribute(CatalogIdentifierType[] catEntryIds,
                                                         java.util.Map[] attributes)
                                                  throws CatalogException

Update catalog attribute

Parameters:

catEntryIds -

attributes -

Returns:

RespondCatalogDataAreaType

Throws:

CatalogException

updateCatalogDescription

public RespondCatalogDataAreaType updateCatalogDescription(CatalogIdentifierType catEntryId,
                                                           CatalogDescriptionType[] catEntryDescs)
                                                    throws CatalogException

RespondCatalogDataAreaType

Parameters:

catEntryId -

catEntryDescs -

Returns:

RespondCatalogDataAreaType

Throws:

CatalogException

createCatalogDataObject

public CatalogType createCatalogDataObject(CatalogIdentifierType catEntryId)

This method creates an instance of CatalogType object with the given catalog entry id.

Parameters:

catEntryId - The catalog entry identifier assoicated with the data object.

Returns:

A new instance of the CatalogType object

changeCatalog

public RespondCatalogDataAreaType changeCatalog(java.lang.String[] action,
                                                CatalogType[] catEntries,
                                                java.lang.String[] expression)
                                         throws CatalogException

This method changes the catalog entry.

Parameters:

action - the action to be applied to the catalog entry.

catEntries - the catalog entry to be changed.

expression - the expression corresponding to each action in the list.

Returns:

The RespondCatalogDataAreaType that contains the catalog entry Id.

Throws:

CatalogException

updateCatalogDescription

public RespondCatalogDataAreaType updateCatalogDescription(CatalogType[] catalogs)
                                                    throws CatalogException

This method updates multiple catalog descriptions of a single catalog .

Parameters:

catalogs - The catalogs for which the description is to be updated.

Returns:

The RespondCatalogGroupDataAreaType that contains the catalog id and the updated catalog .

Throws:

CatalogException

getCatalogEntryWithPaging

public java.util.Hashtable getCatalogEntryWithPaging(java.lang.String expressionLanguage,
                                                     java.lang.String expression,
                                                     java.lang.String maxItems,
                                                     java.lang.String refId,
                                                     java.lang.String startNum)
                                              throws CatalogEntryException

This method provides support for paging. Look at the returned hashtable description to see how paging values are passed back. Look at the parameters to be supplied for details on what paging parameters are to be passed in. It returns a list of base catalog entries based on the expression specified along with following paging parameters:

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of base catalog entries.

maxItems - Specifies max no of records to be retrieved.

refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.

startNum - The starting index from which to retrieve results from the result set

Returns:

Returns a Hashtable containing the list of catalog entries that matches the expression specified and paging parameters. Following keys are used in the Hashtable:

• 'response' - Used to store List containing Catalog Entries.
• 'recordCount' - The number of records from the result set that are being returned in this message.
• 'refId' - The internal identifier for the result set, so that it can be resolved on a subsequent request.
• 'startNumber' - The starting index for the results that are being returned in this message.
• 'totalRecords' - The total number of results in the result set.

Throws:

CatalogEntryException

getCatalogGroupWithPaging

public java.util.Hashtable getCatalogGroupWithPaging(java.lang.String expressionLanguage,
                                                     java.lang.String expression,
                                                     java.lang.String maxItems,
                                                     java.lang.String refId,
                                                     java.lang.String startNum)
                                              throws CatalogGroupException

This method provides support for paging. Look at the returned hashtable description to see how paging values are passed back. Look at the parameters to be supplied for details on what paging parameters are to be passed in. It returns a list of base catalog groups based on the expression specified along with following paging parameters:

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of base catalog groups.

maxItems - Specifies max no of records to be retrieved.

refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.

startNum - The starting index from which to retrieve results from the result set

Returns:

Returns a Hashtable containing the list of catalog groups that matches the expression specified and paging parameters. Following keys are used in the Hashtable:

• 'response' - Used to store List containing Catalog Groups.
• 'recordCount' - The number of records from the result set that are being returned in this message.
• 'refId' - The internal identifier for the result set, so that it can be resolved on a subsequent request.
• 'startNumber' - The starting index for the results that are being returned in this message.
• 'totalRecords' - The total number of results in the result set.

Throws:

CatalogGroupException