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.
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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
protected CatalogDescriptionType[] | buildCatalogDescriptionDataObject(java.util.Map parameters)
This methods build a list of CatalogEntryIdentiferType objects from the input parameter parameters.
|
protected CatalogIdentifierType[] | buildSalesCatalogIdentifierDataObject(java.util.Map parameters)
This methods build a list of CatalogEntryIdentiferType objects from the input parameter parameters.
|
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.
|
protected ChangeCatalogType | createChangeCatalogDataObject()
This method creates an instance of ChangeCatalogType object.
|
protected ProcessCatalogType | createProcessCatalogDataObject()
This method creates an instance of ProcessCatalogType object.
|
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.
|
protected java.lang.String | getXPathForSalesCatalog(CatalogType catalogDataObject, int i)
This returns the XPath for deleting a sales catalog.
|
protected java.lang.String | getXPathForSalesCatalogDescription(CatalogType catalogDataObject, int i)
This returns the XPath for deleting a sales catalog.
|
protected void | populateResponse(java.util.Map response, java.lang.String actionName, AcknowledgeCatalogDataAreaType respondCatalogDataArea)
The customer can extend this method to retrieve more inforamtion from the RespondCatalogEntry
|
protected void | populateResponse(java.util.Map response, java.lang.String actionName, RespondCatalogDataAreaType respondCatalogDataArea)
The customer can extend this method to retrieve more inforamtion from the RespondCatalogEntry
|
AcknowledgeCatalogDataAreaType | processCatalog(java.lang.String[] actionArray, CatalogType[] catentries, java.lang.String[] strXPaths)
This method process the catalog entry.
|
protected java.lang.String[] | resolveParameter(java.util.Map parameters, java.lang.String key)
This method resolves parameters from the input Map
|
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
|
public static final java.lang.String PROCESS_VERB_ACTION_ADD
public static final java.lang.String PROCESS_VERB_ACTION_CREATE
public static final java.lang.String PROCESS_VERB_ACTION_DELETE
public CatalogFacadeClient()
public CatalogFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
public java.util.List fetchCatalog(java.lang.String xPath) throws CatalogException
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.
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.
public java.util.Map changeSalesCatalogDescription(java.util.Map parameters) throws CatalogException
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.
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.
protected java.lang.String[] resolveParameter(java.util.Map parameters, java.lang.String key) throws CatalogException
protected CatalogDescriptionType[] buildCatalogDescriptionDataObject(java.util.Map parameters) throws CatalogException
catentryId : This is of type String[]. The internal reference ids of the catalog entries. partnumber: This is of type String[]. The external reference ids of the catalog entries.
protected CatalogIdentifierType[] buildSalesCatalogIdentifierDataObject(java.util.Map parameters) throws CatalogException
catentryId : This is of type String[]. The internal reference ids of the catalog entries. partnumber: This is of type String[]. The external reference ids of the catalog entries.
protected java.lang.String getXPathForSalesCatalog(CatalogType catalogDataObject, int i)
protected java.lang.String getXPathForSalesCatalogDescription(CatalogType catalogDataObject, int i)
protected void populateResponse(java.util.Map response, java.lang.String actionName, AcknowledgeCatalogDataAreaType respondCatalogDataArea) throws CatalogException
protected void populateResponse(java.util.Map response, java.lang.String actionName, RespondCatalogDataAreaType respondCatalogDataArea) throws CatalogException
public AcknowledgeCatalogDataAreaType createCatalog(java.util.List catalogEntryList) throws CatalogException
public AcknowledgeCatalogDataAreaType processCatalog(java.lang.String[] actionArray, CatalogType[] catentries, java.lang.String[] strXPaths) throws CatalogException
protected ProcessCatalogType createProcessCatalogDataObject()
public AcknowledgeCatalogDataAreaType deleteCatalog(CatalogIdentifierType[] catGroupIds) throws CatalogException
public RespondCatalogDataAreaType updateCatalogDescription(CatalogIdentifierType[] catEntryIds, CatalogDescriptionType[] catEntryDescs) throws CatalogException
public RespondCatalogDataAreaType updateCatalogIdentifier(CatalogIdentifierType[] catEntryIds) throws CatalogException
public RespondCatalogDataAreaType updateCatalogAttribute(CatalogIdentifierType[] catEntryIds, java.util.Map[] attributes) throws CatalogException
public RespondCatalogDataAreaType updateCatalogDescription(CatalogIdentifierType catEntryId, CatalogDescriptionType[] catEntryDescs) throws CatalogException
public CatalogType createCatalogDataObject(CatalogIdentifierType catEntryId)
public RespondCatalogDataAreaType changeCatalog(java.lang.String[] action, CatalogType[] catEntries, java.lang.String[] expression) throws CatalogException
protected ChangeCatalogType createChangeCatalogDataObject()
public RespondCatalogDataAreaType updateCatalogDescription(CatalogType[] catalogs) throws CatalogException
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
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