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.
|
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
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 |
---|---|
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
|
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
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
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)
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.public java.util.List fetchCatalog(java.lang.String xPath) throws CatalogException
xPath
- The XPath for the get.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.
parameters
- : list of parameters.CatalogException
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.
parameters
- : Map of input parameters.CatalogException
public java.util.Map changeSalesCatalogDescription(java.util.Map parameters) throws CatalogException
parameters
- : A map of input parameters.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.
parameters
- : Map of input parameters.CatalogException
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.
parameters
- : Map of input parameters.CatalogException
public AcknowledgeCatalogDataAreaType createCatalog(java.util.List catalogEntryList) throws CatalogException
CatalogType
objects containg the all teh information related to the catentry.catalogEntryList
- a list of CatalogType
objects to be created.AcknowledgeCatalogDataAreaType
CatalogException
public AcknowledgeCatalogDataAreaType processCatalog(java.lang.String[] actionArray, CatalogType[] catentries, java.lang.String[] strXPaths) throws CatalogException
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.CatalogException
public AcknowledgeCatalogDataAreaType deleteCatalog(CatalogIdentifierType[] catGroupIds) throws CatalogException
catGroupIds
- The ids of the catalog Group to be deleted.CatalogException
public RespondCatalogDataAreaType updateCatalogDescription(CatalogIdentifierType[] catEntryIds, CatalogDescriptionType[] catEntryDescs) throws CatalogException
catEntryIds
- catEntryDescs
- CatalogException
public RespondCatalogDataAreaType updateCatalogIdentifier(CatalogIdentifierType[] catEntryIds) throws CatalogException
catEntryIds
- CatalogException
public RespondCatalogDataAreaType updateCatalogAttribute(CatalogIdentifierType[] catEntryIds, java.util.Map[] attributes) throws CatalogException
catEntryIds
- attributes
- CatalogException
public RespondCatalogDataAreaType updateCatalogDescription(CatalogIdentifierType catEntryId, CatalogDescriptionType[] catEntryDescs) throws CatalogException
catEntryId
- catEntryDescs
- CatalogException
public CatalogType createCatalogDataObject(CatalogIdentifierType catEntryId)
CatalogType
object with the given catalog entry id.catEntryId
- The catalog entry identifier assoicated with the data object.CatalogType
objectpublic RespondCatalogDataAreaType changeCatalog(java.lang.String[] action, CatalogType[] catEntries, java.lang.String[] expression) throws CatalogException
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.CatalogException
public RespondCatalogDataAreaType updateCatalogDescription(CatalogType[] catalogs) throws CatalogException
catalogs
- The catalogs for which the description is to be updated.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
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 setHashtable
containing the list of catalog entries that matches the expression specified
and paging parameters. Following keys are used in the Hashtable
:
List
containing Catalog Entries.
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
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 setHashtable
containing the list of catalog groups that matches the expression specified
and paging parameters. Following keys are used in the Hashtable
:
List
containing Catalog Groups.
CatalogGroupException