public class CatalogGroupFacadeClient extends AbstractCatalogFacadeClient
Modifier and Type | Field and Description |
---|---|
static java.lang.String | CHANGE_VERB_ACTION_CHANGE
The change verb constant to represents the action of Update.
|
static java.lang.String | CHANGE_VERB_ACTION_CREATE
The change verb constant to represents the action of Create.
|
static java.lang.String | CHANGE_VERB_ACTION_DELETE
The change verb constant to represents the action of Delete.
|
Constructor and Description |
---|
CatalogGroupFacadeClient()
Creates an instance of the client to communicate with the Catalog facade.
|
CatalogGroupFacadeClient(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 |
---|---|
java.util.Map | addCatalogGroupParent(java.util.Map parameters)
This method builds and sends the request for adding the parent of a catalog group.
|
protected CatalogDescriptionType[] | buildCatalogGroupDescriptionDataObject(java.util.Map parameters, int anNumOfCatGroupDescs)
This methods build a list of CatalogDescriptionType objects from the input parameter parameters.
|
protected CatalogGroupIdentifierType[] | buildCatalogGroupIdentifierDataObject(java.util.Map parameters)
This methods build a list of CatalogGroupIdentiferType objects from the input parameter parameters.
|
protected NavigationRelationshipType[] | buildNavigationalRelationshipChildCatalogGroup(java.util.Map parameters)
This methods build a list of NavigationRelationshipType objects from the input parameter parameters.
|
protected NavigationRelationshipType[] | buildNavigationalRelationshipChildProduct(java.util.Map parameters)
This methods build a list of NavigationRelationshipType objects from the input parameter parameters.
|
protected CatalogGroupIdentifierType[] | buildParentCatalogGroupIdentifierDataObject(java.util.Map parameters)
This methods build a list of (Parent)CatalogGroupIdentiferType objects from the input parameter parameters.
|
RespondCatalogGroupType | changeCatalogGroup(ChangeCatalogGroupType argChangeCatalogGroup)
This method will communicate with the Order facade and send the specified ChangeOrder request.
|
RespondCatalogGroupDataAreaType | changeCatalogGroup(java.lang.String[] action, CatalogGroupType[] catGroups, java.lang.String[] expression)
This method changes the catalog Group.
|
AcknowledgeCatalogGroupDataAreaType | createCatalogGroup(CatalogGroupIdentifierType[] catGroupIds, CatalogGroupIdentifierType[] parentCatGroupIdentifiers)
This method creates the catalog Group.
|
java.util.Map | createCatalogGroup(java.util.Map parameters)
This method creates the catalog groups.
|
protected CatalogGroupType | createCatalogGroupDataObject(CatalogGroupIdentifierType catGroupId)
This method creates an instance of CatalogGroupType object with the given catalog group id.
|
RespondCatalogGroupDataAreaType | createCatalogGroupDescription(CatalogGroupIdentifierType[] catGroupIds, CatalogDescriptionType[] catGroupDescs, CatalogGroupIdentifierType[] parentCatGroupIdentifiers)
This method creates the catalog Group descriptions.
|
RespondCatalogGroupDataAreaType | createCatalogGroupDescription(CatalogGroupIdentifierType catGroupId, CatalogDescriptionType[] catGroupDescs, CatalogGroupIdentifierType[] parentCatGroupIdentifiers)
This method creates multiple descriptions for a single catalog Group.
|
java.util.Map | createCatalogGroupDescription(java.util.Map parameters)
This method creates the description(s) of the catalog groups.
|
protected ChangeCatalogGroupType | createChangeCatalogGroupDataObject()
This method creates an instance of ChangeCatalogGroupType object.
|
protected ProcessCatalogGroupType | createProcessCatalogGroupDataObject()
This method creates an instance of ProcessCatalogGroupType object.
|
AcknowledgeCatalogGroupDataAreaType | deleteCatalogGroup(CatalogGroupIdentifierType[] catGroupIds)
This method deletes the catalog Group.
|
java.util.Map | deleteCatalogGroup(java.util.Map parameters)
This method deletes the catalog groups.
|
java.util.Map | deleteCatalogGroupParent(java.util.Map parameters)
This method builds and sends the request for deleting the parent of a catalog group.
|
java.util.List | fetchCatalogGroup(java.lang.String xPath)
This method is used to pass the get catalog group BOD, and return the SHOW catalog group BOD.
|
java.util.Hashtable | fetchCatalogGroupWithPaging(java.lang.String xPath, java.lang.String maxNumber, java.lang.String refId, java.lang.String startIndex)
This method is used to pass the get catalog group BOD, and return the SHOW catalog group BOD with paging.
|
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 void | populateResponse(java.util.Map response, java.lang.String actionName, RespondCatalogGroupDataAreaType respondCatalogGroupDataArea)
The customer can extend this method to retrieve more inforamtion from the RespondCatalogGroup
|
AcknowledgeCatalogGroupType | processCatalogGroup(ProcessCatalogGroupType argProcessCatGroup)
This method will communicate with the Order facade and send the specified ProcessOrder request.
|
AcknowledgeCatalogGroupDataAreaType | processCatalogGroup(java.lang.String[] actionArray, CatalogGroupType[] catgroups, java.lang.String[] strXPaths)
This method processes the catalog Group.
|
protected java.lang.String[] | resolveParameter(java.util.Map parameters, java.lang.String key)
This method resolves parameters from the input Map
|
RespondCatalogGroupDataAreaType | updateCatalogGroup(CatalogGroupIdentifierType[] catGroupIds, java.lang.String[] isTopCategory)
This method updates the catalog Group.
|
RespondCatalogGroupDataAreaType | updateCatalogGroup(CatalogGroupIdentifierType[] catGroupIds, java.lang.String[] isTopCategory, java.lang.String[] sequence)
This method updates the catalog Group.
|
java.util.Map | updateCatalogGroup(java.util.Map parameters)
This method updates the the catalog groups.
|
RespondCatalogGroupDataAreaType | updateCatalogGroupAttributes(CatalogGroupType[] catGrpArray, java.lang.String[] actions)
This method builds the xpath and calls the service to update the catalog group attributes.
|
RespondCatalogGroupDataAreaType | updateCatalogGroupDescription(CatalogGroupIdentifierType[] catGroupIds, CatalogDescriptionType[] catGroupDescs)
This method updates the catalog Group descriptions.
|
RespondCatalogGroupDataAreaType | updateCatalogGroupDescription(CatalogGroupIdentifierType catGroupId, CatalogDescriptionType[] catGroupDescs)
This method updates multiple descriptions of a single catalog group .
|
RespondCatalogGroupDataAreaType | updateCatalogGroupDescription(CatalogGroupType[] catGroups)
This method updates multiple catalog group descriptions of a single catalog group.
|
java.util.Map | updateCatalogGroupDescription(java.util.Map parameters)
This method updates the description(s) of the catalog groups.
|
RespondCatalogGroupDataAreaType | updateCatalogGroupIdentifier(CatalogGroupType[] catGrpArray, java.lang.String[] actions)
This method builds the xpath and calls the service to update the catalog group identifier.
|
java.util.Map | updateCatalogGroupNavigationRelationship(java.util.Map parameters, boolean isChildProduct, boolean isChildCatalogGroup)
This method updates the navigation relationship(s) of the catalog groups.
|
RespondCatalogGroupDataAreaType | updateCatalogGroupNavRel(CatalogGroupIdentifierType[] catGroupIds, NavigationRelationshipType[] catGroupNavRel)
This method updates the display sequence of the following relationship:
parent catalog group to child catalog entry relationship. parent catalog group to child catalog group relationship. |
RespondCatalogGroupDataAreaType | updateCatalogGroupNavRel(java.util.List catGroupList)
This method updates the display sequence of multiple child catalog groups belonging to multiple parent catalog groups for the following relationship:
parent catalog group to child catalog entry relationship. parent catalog group to child catalog group relationship. |
RespondCatalogGroupDataAreaType | updateCatalogGroupParent(CatalogGroupIdentifierType[] catGroupIdentifiers, CatalogGroupIdentifierType[] parentCatGrpIdentfiers, java.lang.String[] actions)
This method builds and sends the request for updating the parent of a catalog group.
|
java.util.Map | updateCatalogGroupParent(java.util.Map parameters)
This method builds and sends the request for updating the parent of a catalog group.
|
java.util.Map | updateTopCatalogGroupSequence(java.util.Map parameters)
This method updates the sequence of top catalog groups with respect to its catalog
Sample code to use the API: |
public static final java.lang.String CHANGE_VERB_ACTION_CHANGE
public static final java.lang.String CHANGE_VERB_ACTION_CREATE
public static final java.lang.String CHANGE_VERB_ACTION_DELETE
public CatalogGroupFacadeClient()
public CatalogGroupFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
public java.util.List fetchCatalogGroup(java.lang.String xPath) throws CatalogGroupException
public java.util.Hashtable fetchCatalogGroupWithPaging(java.lang.String xPath, java.lang.String maxNumber, java.lang.String refId, java.lang.String startIndex) throws CatalogGroupException
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
public RespondCatalogGroupDataAreaType changeCatalogGroup(java.lang.String[] action, CatalogGroupType[] catGroups, java.lang.String[] expression) throws CatalogGroupException
public RespondCatalogGroupType changeCatalogGroup(ChangeCatalogGroupType argChangeCatalogGroup)
protected ChangeCatalogGroupType createChangeCatalogGroupDataObject()
protected CatalogGroupType createCatalogGroupDataObject(CatalogGroupIdentifierType catGroupId)
public RespondCatalogGroupDataAreaType updateCatalogGroupDescription(CatalogGroupIdentifierType catGroupId, CatalogDescriptionType[] catGroupDescs) throws CatalogGroupException
public RespondCatalogGroupDataAreaType updateCatalogGroupDescription(CatalogGroupIdentifierType[] catGroupIds, CatalogDescriptionType[] catGroupDescs) throws CatalogGroupException
protected void populateResponse(java.util.Map response, java.lang.String actionName, RespondCatalogGroupDataAreaType respondCatalogGroupDataArea) throws CatalogGroupException
public java.util.Map updateCatalogGroupDescription(java.util.Map parameters) throws CatalogGroupException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.updateCatalogGroupDescription(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
catGroupId : The internal reference ids of the catalog groups to be updated. identifier: The external reference ids of the catalog groups to be updated. languageId: The langeuage ids to be used to update the descriptions. name: The name to be updated for the given catalog Group description. sDesc: The short description to be updated for the given catalog Group description. lDesc : The long description to be updated for the given catalog Group description. tImage: The thumbnail image to be updated for the given catalog Group description. fImage: The full image to be updated for the given catalog Group description. keyword: The keyword value can be used for search.
protected java.lang.String[] resolveParameter(java.util.Map parameters, java.lang.String key) throws CatalogGroupException
protected CatalogDescriptionType[] buildCatalogGroupDescriptionDataObject(java.util.Map parameters, int anNumOfCatGroupDescs) throws CatalogGroupException
protected CatalogGroupIdentifierType[] buildCatalogGroupIdentifierDataObject(java.util.Map parameters) throws CatalogGroupException
protected CatalogGroupIdentifierType[] buildParentCatalogGroupIdentifierDataObject(java.util.Map parameters) throws CatalogGroupException
public java.util.Map createCatalogGroupDescription(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.createCatalogGroupDescription(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
identifier: The external reference ids of the catalog groups to be updated. languageId: The langeuage ids to be used to update the descriptions. name: The name to be updated for the given catalog Group description. sDesc: The short description to be updated for the given catalog Group description. lDesc : The long description to be updated for the given catalog Group description. tImage: The thumbnail image to be updated for the given catalog Group description. fImage: The full image to be updated for the given catalog Group description. keyword: The keyword value can be used for search.
public RespondCatalogGroupDataAreaType createCatalogGroupDescription(CatalogGroupIdentifierType[] catGroupIds, CatalogDescriptionType[] catGroupDescs, CatalogGroupIdentifierType[] parentCatGroupIdentifiers) throws CatalogGroupException
public RespondCatalogGroupDataAreaType createCatalogGroupDescription(CatalogGroupIdentifierType catGroupId, CatalogDescriptionType[] catGroupDescs, CatalogGroupIdentifierType[] parentCatGroupIdentifiers) throws CatalogGroupException
public java.util.Map createCatalogGroup(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.createCatalogGroup(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
public AcknowledgeCatalogGroupDataAreaType createCatalogGroup(CatalogGroupIdentifierType[] catGroupIds, CatalogGroupIdentifierType[] parentCatGroupIdentifiers) throws CatalogGroupException
public java.util.Map updateCatalogGroup(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.updateCatalogGroup(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
public java.util.Map updateTopCatalogGroupSequence(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.updateTopCatalogGroupSequence(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
public RespondCatalogGroupDataAreaType updateCatalogGroup(CatalogGroupIdentifierType[] catGroupIds, java.lang.String[] isTopCategory) throws CatalogGroupException
public RespondCatalogGroupDataAreaType updateCatalogGroup(CatalogGroupIdentifierType[] catGroupIds, java.lang.String[] isTopCategory, java.lang.String[] sequence) throws CatalogGroupException
public AcknowledgeCatalogGroupDataAreaType processCatalogGroup(java.lang.String[] actionArray, CatalogGroupType[] catgroups, java.lang.String[] strXPaths) throws CatalogGroupException
public AcknowledgeCatalogGroupType processCatalogGroup(ProcessCatalogGroupType argProcessCatGroup)
protected ProcessCatalogGroupType createProcessCatalogGroupDataObject()
public java.util.Map updateCatalogGroupNavigationRelationship(java.util.Map parameters, boolean isChildProduct, boolean isChildCatalogGroup) throws CatalogGroupException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.updateCatalogGroupNavigationRelationship(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
protected NavigationRelationshipType[] buildNavigationalRelationshipChildProduct(java.util.Map parameters) throws CatalogGroupException
protected NavigationRelationshipType[] buildNavigationalRelationshipChildCatalogGroup(java.util.Map parameters) throws CatalogGroupException
public RespondCatalogGroupDataAreaType updateCatalogGroupNavRel(CatalogGroupIdentifierType[] catGroupIds, NavigationRelationshipType[] catGroupNavRel) throws CatalogGroupException
The method will resolve the Catalog Group to be updated using the CatalogGroupIdentifier passed in the BOD. The NavigationRelationship in BOD contains the child object of the navigational relationship. Depending on the object passed in the NavigationRelationship, the command will update the display sequence of the relationships mentioned above.
public RespondCatalogGroupDataAreaType updateCatalogGroupNavRel(java.util.List catGroupList) throws CatalogGroupException
The method will resolve the Catalog Group to be updated using the CatalogGroupIdentifier passed in the BOD . The NavigationRelationship in BOD contains the child object of the navigational relationship. Depending on the object passed in the NavigationRelationship, the command will update the display sequence of the relationships mentioned above.
public java.util.Map deleteCatalogGroup(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
CatalogGroupFacadeClient client = new CatalogGroupFacadeClient(businessContext,null); Map response = client.deleteCatalogGroup(parameters); String[] outCatGroupIds = (String[]) response.get("catGroupId");
public AcknowledgeCatalogGroupDataAreaType deleteCatalogGroup(CatalogGroupIdentifierType[] catGroupIds) throws CatalogGroupException
public RespondCatalogGroupDataAreaType updateCatalogGroupParent(CatalogGroupIdentifierType[] catGroupIdentifiers, CatalogGroupIdentifierType[] parentCatGrpIdentfiers, java.lang.String[] actions) throws CatalogGroupException
public java.util.Map updateCatalogGroupParent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
public java.util.Map addCatalogGroupParent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
public java.util.Map deleteCatalogGroupParent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
public RespondCatalogGroupDataAreaType updateCatalogGroupAttributes(CatalogGroupType[] catGrpArray, java.lang.String[] actions) throws CatalogGroupException
public RespondCatalogGroupDataAreaType updateCatalogGroupIdentifier(CatalogGroupType[] catGrpArray, java.lang.String[] actions) throws CatalogGroupException
public RespondCatalogGroupDataAreaType updateCatalogGroupDescription(CatalogGroupType[] catGroups) throws CatalogGroupException
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