public class CatalogEntryFacadeClient extends AbstractCatalogFacadeClient
This class provides common methods to the base catalog entry facade that this and other utility classes can use. This class also provides a set of convenient Java API to represent particular base catalog entry operation. This set of Java API also includes 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 |
CHANGE_VERB_ACTION_CHANGE
The change verb constant to represents the action of Change.
|
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 Delete.
|
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
Constructor and Description |
---|
CatalogEntryFacadeClient()
This method creates an instance of the client to communicate with the
Base Catalog Entry facade.
|
CatalogEntryFacadeClient(BusinessContextType businessContext,
javax.security.auth.callback.CallbackHandler callbackHandler)
This method creates an instance of the client to communicate with the
Base Catalog Entry facade.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map |
addCatalogEntryAssociation(java.util.Map parameters)
This method is used to add catalog entry merchandising associations to
one or many catalog entries.
|
java.util.Map |
addCatalogEntryKitComponent(java.util.Map parameters)
This method is called to add one or many catalog entry kit components
to one or many catalog entries.
|
java.util.Map |
addCatalogEntryParent(java.util.Map parameters)
This method adds a Parent to catalog entries.
|
RespondCatalogEntryDataAreaType |
addCatalogEntryParentCatGroup(CatalogEntryIdentifierType[] catEntIds,
CatalogGroupIdentifierType[] parentCatGrpIdentfiers)
This method builds and sends the request for adding the parent catalog
group of products.
|
AssociationType[] |
buildCatalogEntryMerchandisingAssociationDataObject(CatalogEntryIdentifierType[] associationIdentifiers,
java.util.Map parameters) |
RespondCatalogEntryDataAreaType |
changeCatalogEntry(java.lang.String[] action,
CatalogEntryType[] catEntries,
java.lang.String[] expression)
This method changes the catalog entry.
|
RespondCatalogEntryDataAreaType |
changeCatalogEntryAssociation(CatalogEntryIdentifierType[] parentIdentifiers,
AssociationType[] associations,
java.lang.String action)
This method updates the catalog entry merchandising associations.
|
java.util.Map |
changeCatalogEntryAssociation(java.util.Map parameters)
This method is used to change the merchandising associations of a
catalog entry.
|
java.util.Map |
changeCatalogEntryAssociation(java.util.Map parameters,
java.lang.String action)
Creates a CatalogEntry Association Object with the given input
parameters.
|
java.util.Map |
changeCatalogEntryKitComponent(java.util.Map parameters)
Use this method to change one or many catalog entry kit components.
|
java.util.Map |
changeCatalogEntryKitComponent(java.util.Map parameters,
java.lang.String action)
Creates a CatalogEntry Association Object with the given input
parameters.
|
RespondCatalogEntryDataAreaType |
changeCatalogEntryKitComponents(CatalogEntryIdentifierType[] catEntryIdentifiers,
KitComponentType[] kitComponents,
java.lang.String[] catenttypes,
java.lang.String action)
This method updates the catalog entry kit components.
|
AcknowledgeCatalogEntryDataAreaType |
createCatalogEntry(java.util.List catalogEntryList)
This method builds and sends the request to create catalog entries.
|
java.util.Map |
createCatalogEntry(java.util.Map parameters)
Creates a CatalogEntryType object with the given input parameters
Sample code to use the API: |
java.util.Map |
createCatalogEntryAssociation(java.util.Map parameters)
Creates a CatalogEntry Association Object with the given input
parameters.
|
java.util.Map |
createCatalogEntryAttributes(java.util.Map parameters)
This method will create attributes for a catalog entry with the given
input parameters.
|
GetCatalogEntryType |
createGetCatalogEntry()
Returns a new instance of the
GetBaseCatalogEntryType
object. |
java.util.Map |
createSKU(java.util.Map parameters)
This method create SKUs.
|
AcknowledgeCatalogEntryDataAreaType |
deleteCatalogEntry(java.util.List catalogEntryList)
This method builds and sends the request to delete catalog entries.
|
java.util.Map |
deleteCatalogEntry(java.util.Map parameters)
Deletes a CatalogEntryType object with the given input parameters
|
java.util.Map |
deleteCatalogEntryAssociation(java.util.Map parameters)
This method is used to delete a catalog entry merchandising association.
|
java.util.Map |
deleteCatalogEntryAttributes(java.util.Map parameters)
This method will delete attributes for a catalog entry with the given
input parameters.
|
java.util.Map |
deleteCatalogEntryKitComponent(java.util.Map parameters)
Use this method to delete one or many catalog entry kit components of
one or many catalog entries.
|
java.util.Map |
deleteCatalogEntryParent(java.util.Map parameters)
This method builds and sends the request for deleting the parent of a
catalog entry.
|
ShowCatalogEntryDataAreaType |
getCatalogEntry(GetType getVerb)
This method returns the
ShowCatalogEntryDataAreaType when
issuing the specified get expression to fetch base catalog entry. |
java.util.List |
getCatalogEntry(java.lang.String expressionLanguage,
java.lang.String expression)
This method returns a list of base catalog entries based on the
expression specified.
|
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.
|
AcknowledgeCatalogEntryDataAreaType |
processCatalogEntry(java.lang.String[] actionArray,
CatalogEntryType[] catentries,
java.lang.String[] strXPaths)
This method processes the catalog entry.
|
java.util.Map |
removeCatalogEntryChild(java.util.Map parameters)
Removes child of CatalogEntry
|
RespondCatalogEntryDataAreaType |
updateCatalogEntry(CatalogEntryIdentifierType[] catEntIds)
This method builds and sends the request for updating the products.
|
java.util.Map |
updateCatalogEntry(java.util.Map parameters)
This method updates the catalog entries.
|
java.util.Map |
updateCatalogEntryAttributes(java.util.Map parameters)
This method will update attributes for a catalog entry with the given
input parameters.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryDescription(CatalogEntryIdentifierType[] catEntryIds,
CatalogDescriptionType[] catEntryDescs)
This method updates the catalog entry descriptions.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryDescription(CatalogEntryIdentifierType catEntryId,
CatalogDescriptionType[] catEntryDescs)
This method updates the catalog entry descriptions.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryDescription(CatalogEntryType[] catEntries)
This method updates multiple catalog entry descriptions of a single catalog entry.
|
java.util.Map |
updateCatalogEntryDescription(java.util.Map parameters)
Update the catalog entry description.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryFulfillmentProperties(CatalogEntryIdentifierType[] catEntryId,
CatalogEntryFulfillmentPropertiesType[] catalogFulfill)
This method updates the catalog entry fulfillment properties.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryListPrice(CatalogEntryIdentifierType[] catEntryIds,
UnitPriceType[] catEntryListPrices)
This method updates the catalog entry list prices.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryListPrice(CatalogEntryIdentifierType catEntryId,
UnitPriceType[] catEntryListPrices)
This method updates the catalog entry descriptions.
|
java.util.Map |
updateCatalogEntryListPrice(java.util.Map parameters)
This method updates the list price of the catalog entries.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryNavigationRel(CatalogEntryType[] catalogEntriesWithChildren,
java.lang.String[] actions)
This method builds the request for updating the
display sequence of a catalog entry to catalog entry relationship.
|
java.util.Map |
updateCatalogEntryParent(java.util.Map parameters)
This method updates the Parent of catalog entries.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatEntry(CatalogEntryIdentifierType[] catEntIds,
CatalogEntryIdentifierType[] parentCatEntryIdentfiers)
This method builds and sends the request for updating the parent catalog
group of products.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatentry(CatalogEntryIdentifierType[] childCatEntIds,
CatalogEntryIdentifierType[] parentCatentryIdentfiers,
java.lang.String[] actions)
This method builds and sends the request for updating the parent catalog
group of products.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatEntry(CatalogEntryIdentifierType catEntryId,
CatalogEntryIdentifierType parentCatentryIdentfier)
This method builds and sends the request for updating the parent catalog
group of a product.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType[] catEntIds,
CatalogGroupIdentifierType[] parentCatGrpIdentfiers)
This method builds and sends the request for updating the parent catalog
group of products.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType[] catEntIds,
CatalogGroupIdentifierType[] parentCatGrpIdentfiers,
java.lang.String[] actions)
This method builds and sends the request for updating the parent catalog
group of products.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType catEntryId,
CatalogGroupIdentifierType parentCatGrpIdentfier)
This method builds and sends the request for updating the parent catalog
group of a product.
|
RespondCatalogEntryDataAreaType |
updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType catEntryId,
CatalogGroupIdentifierType parentCatGrpIdentfier,
java.lang.String action)
This method builds and sends the request for updating the parent catalog
group of a product.
|
java.util.Map |
updateDynamicKitPreConfiguration(java.util.Map parameters)
Updates the dynamic kit preconfiguration with the given input
parameters.
|
java.util.Map |
updateSKUParent(java.util.Map parameters)
Update the SKU to Product relationship.
|
changeAttributeDictionary, changeAttributeDictionaryAttribute, changeAttributeDictionaryAttributeGroup, changeCatalog, changeCatalogEntry, changeCatalogFilter, changeCatalogGroup, getAttributeDictionary, getAttributeDictionary, getAttributeDictionary, getAttributeDictionaryAttribute, getAttributeDictionaryAttribute, getAttributeDictionaryAttribute, getAttributeDictionaryAttributeGroup, getAttributeDictionaryAttributeGroup, getAttributeDictionaryAttributeGroup, getCatalog, getCatalog, getCatalog, 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 CHANGE_VERB_ACTION_CHANGE
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 CatalogEntryFacadeClient()
public CatalogEntryFacadeClient(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 RespondCatalogEntryDataAreaType changeCatalogEntry(java.lang.String[] action, CatalogEntryType[] catEntries, java.lang.String[] expression) throws CatalogEntryException
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.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryDescription(CatalogEntryIdentifierType catEntryId, CatalogDescriptionType[] catEntryDescs) throws CatalogEntryException
catEntryId
- The id of the catalog entry to be updated.catEntryDescs
- The catalog entry description to be updated.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryFulfillmentProperties(CatalogEntryIdentifierType[] catEntryId, CatalogEntryFulfillmentPropertiesType[] catalogFulfill) throws CatalogEntryException
catEntryId
- The id of the catalog entry to be updated.catalogFulfill
- The catalog entry fulfillment properties to be updated. The
UserData of catalogFulfill can contain the
following parameters: uom , backOrderable
, returnNotDesired , forceBackOrder
, releaseSeparately , trackInventory
, creditable , quantityMultiple
CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryListPrice(CatalogEntryIdentifierType catEntryId, UnitPriceType[] catEntryListPrices) throws CatalogEntryException
catEntryId
- The id of the catalog entry to be updated.catEntryListPrices
- The catalog entry description to be updated.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryDescription(CatalogEntryIdentifierType[] catEntryIds, CatalogDescriptionType[] catEntryDescs) throws CatalogEntryException
catEntryIds
- The ids of the catalog entry to be updated.catEntryDescs
- The catalog entry description to be updated.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryListPrice(CatalogEntryIdentifierType[] catEntryIds, UnitPriceType[] catEntryListPrices) throws CatalogEntryException
catEntryIds
- The ids of the catalog entry to be updated.catEntryListPrices
- The catalog entry description to be updated.CatalogEntryException
public RespondCatalogEntryDataAreaType changeCatalogEntryKitComponents(CatalogEntryIdentifierType[] catEntryIdentifiers, KitComponentType[] kitComponents, java.lang.String[] catenttypes, java.lang.String action) throws CatalogEntryException
catEntryIdentifiers
- The identifiers of the catalog entries to be updated.kitComponents
- The catalog entry kit components to be updated.catenttypes
- The type of catalog entry being updated.action
- The action to be performed.CatalogEntryException
public java.util.Map createCatalogEntry(java.util.Map parameters)
Sample code to use the API:
Map parameters = new HashMap();
parameters.put("catentryId", new String[] { "-10001", "-10002" });
parameters.put("partnumber", new String[] { "AB-12345", "CD-45678" });
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,null);
Map response = client.createCatalogEntry(parameters);
String[] outCatEntryIds = (String[]) response.get("catentryId");
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. catenttypeId: The name of Catentry Type attribute. parentCategoryId: The name of the Catalog entry's Immediate Parent's Unique ID.
public java.util.Map createSKU(java.util.Map parameters)
Sample code to use the API:
Map parameters = new HashMap();
parameters.put("catentryId", new String[] { "-10001", "-10002" });
parameters.put("partnumber", new String[] { "AB-12345", "CD-45678" });
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,null);
Map response = client.createSKU(parameters);
String[] outCatEntryIds = (String[]) response.get("catentryId");
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. catenttypeId: The name of Catentry Type attribute. buyable: The name of the buyable attribute.
public java.util.Map updateCatalogEntryDescription(java.util.Map parameters) throws CatalogEntryException
Sample code to use the API:
Map parameters = new HashMap();
parameters.put("catentryId", new String[] { "-10001", "-10002" });
parameters.put("partnumber", new String[] { "AB-12345", "CD-45678" });
parameters.put("languageId", new String[] { "-1", "-1" });
parameters.put("name", new String[] { "Kevlar Brake Pads",
"'Titanium Brake Pads" });
parameters.put("sDesc", new String[] { "Kevlar Brake Pads",
"'Titanium Brake Pads" });
parameters.put("lDesc", new String[] {
"Kevlar Brake Pads. Comes with a 2 year or 40,000 km warranty.",
"'Titanium Brake Pads. Suitable for all car and truck makes." });
parameters.put("tImage", new String[] { "img/imageFile1_t.jpg",
"img/imageFile2_t.jpg" });
parameters.put("fImage", new String[] { "img/imageFile1_f.jpg",
"img/imageFile2_f.jpg" });
parameters.put("keyword", new String[] { "Brake Pads", "Brake Pads" });
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,
null);
Map response = client.updateCatalogEntryDescription(parameters);
String[] outCatEntryIds = (String[]) response.get("catentryId");
parameters
- This contains the value(s) to be updated for the given catalog
entry descriptions.
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. languageId: The langeuage ids to be used to update the descriptions. name: The name to be updated for the given catalog entry description. sDesc: The short description to be updated for the given catalog entry description. lDesc : The long description to be updated for the given catalog entry description. tImage: The thumbnail image to be updated for the given catalog entry description. fImage: The full image to be updated for the given catalog entry description. keyword: The keyword value can be used for search.
CatalogEntryException
public java.util.Map createCatalogEntryAssociation(java.util.Map parameters) throws CatalogEntryException
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. assocPartNumber: The name of association part number. associationId: The name of association Id. quantity: The name of the merchandising association quantity. sequence: The name of the merchandising association sequence. name: The name of the merchandising association.
CatalogEntryException
public java.util.Map addCatalogEntryAssociation(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- A map of parameters of type String[] containing values for
one or many catalog entries to add merchandising
associations to.AbstractBusinessObjectDocumentException
public java.util.Map changeCatalogEntryAssociation(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- A map of parameters to be used to extract values in order to
determine which catalog entries to change associations for.AbstractBusinessObjectDocumentException
public AcknowledgeCatalogEntryDataAreaType deleteCatalogEntry(java.util.List catalogEntryList) throws CatalogEntryException
CatalogEntryType
objects containing all the information
related to the catentry .catalogEntryList
- a list of CatalogEntryType
objects to be
deleted.AcknowledgeCatalogEntryDataAreaType
CatalogEntryException
public java.util.Map deleteCatalogEntry(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated.
AbstractBusinessObjectDocumentException
public java.util.Map deleteCatalogEntryAssociation(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- A map of parameters used to determine what catalog entry
merchandising associations to delete.AbstractBusinessObjectDocumentException
public java.util.Map changeCatalogEntryAssociation(java.util.Map parameters, java.lang.String action) throws CatalogEntryException
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. assocPartNumber: The name of association part number. associationId: The name of association Id.
action
- The action to perform.CatalogEntryException
public RespondCatalogEntryDataAreaType changeCatalogEntryAssociation(CatalogEntryIdentifierType[] parentIdentifiers, AssociationType[] associations, java.lang.String action) throws CatalogEntryException
parentIdentifiers
- The ids of the catalog entry to be updated.associations
- action
- The catalog entry description to be updated.CatalogEntryException
public AssociationType[] buildCatalogEntryMerchandisingAssociationDataObject(CatalogEntryIdentifierType[] associationIdentifiers, java.util.Map parameters)
associationIdentifiers
- An array of CatalogEntryIdentifierTypes for all the
merchandising association catalog entries to build
AssociationTypes for.parameters
- A map of parameters to use for creating AssociationType,
such as quantity and sequence.
quantity: The name of the merchandising association quantity. sequence: The name of the merchandising association sequence. name: The name of the merchandising association. associationId: The name of association Id.
public java.util.Map addCatalogEntryKitComponent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- A map of parameters to use to add catalog entry kit
components.
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. parentCatentryId: The name of the Catalogentry's Immediate Parent's Unique ID. catenttypeId: The name of Catentry Type attribute. quantity: The name of quantity. sequence: The name of sequence.
AbstractBusinessObjectDocumentException
public java.util.Map changeCatalogEntryKitComponent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- A map of parameters.
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. parentCatentryId: The name of the Catalogentry's Immediate Parent's Unique ID. catenttypeId: The name of Catentry Type attribute. quantity: The name of quantity. sequence: The name of sequence.
AbstractBusinessObjectDocumentException
public java.util.Map deleteCatalogEntryKitComponent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- A map of parameters. The parameters are of type String[] to
be used for one or more values for multiple operations to be
performed.AbstractBusinessObjectDocumentException
public java.util.Map changeCatalogEntryKitComponent(java.util.Map parameters, java.lang.String action) throws CatalogEntryException
parameters
- The map of parameters to be used.
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. parentCatentryId: The name of the Catalogentry's Immediate Parent's Unique ID. catenttypeId: The name of Catentry Type attribute. quantity: The name of quantity. sequence: The name of sequence.
action
- The action to perform.CatalogEntryException
public java.util.Map removeCatalogEntryChild(java.util.Map parameters) throws CatalogEntryException
parameters
- catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated.
CatalogEntryException
public java.util.Map updateCatalogEntryListPrice(java.util.Map parameters) throws CatalogEntryException
Sample code to use the API:
Map parameters = new HashMap();
parameters.put("catentryId", new String[] { "-10001", "-10002" });
parameters.put("partnumber", new String[] { "AB-12345", "CD-45678" });
parameters.put("listprice", new String[] { 100, 200 });
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,
null);
Map response = client.updateCatalogEntryListPrice(parameters);
String[] outCatEntryIds = (String[]) response.get("catentryId");
parameters
- This contains the value(s) to be updated for the given
catalog entry.
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. listprice: The name of the List Price attribute. listpriceCurrency: The name of the Currency attribute of the List Price.
CatalogEntryException
public java.util.Map createCatalogEntryAttributes(java.util.Map parameters) throws CatalogEntryException
Sample code to use the API:
Map parameters = new HashMap();
parameters.put("catentryId", new String[] { "-10001", "-10002" });
parameters.put("partnumber", new String[] { "AB-12345", "CD-45678" });
parameters.put("attrName", new String[] { "color" });
parameters.put("attrDataType", new String[] { "string" });
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,null);
Map response = client.updateCatalogEntryDescription(parameters);
String[] outCatEntryIds = (String[]) response.get("catentryId");
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. attrName: The name of attribute. attrUsage: The name of Usage of attribute. attrDataType: The data type of the attribute. attrDisplaySequence : The display sequence of the attribute. attrDescription: The description of the attribute.
CatalogEntryException
- A CatalogEntryException
is thrown if the
attributes could not be created.public java.util.Map updateCatalogEntryAttributes(java.util.Map parameters) throws CatalogEntryException
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. attrName: The name of attribute. attrUsage: The name of Usage of attribute. attrDataType: The data type of the attribute. attrDisplaySequence : The display sequence of the attribute. attrDescription: The description of the attribute.
CatalogEntryException
- A CatalogEntryException
is thrown if the
attributes could not be updated.public java.util.Map deleteCatalogEntryAttributes(java.util.Map parameters) throws CatalogEntryException
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. attrName: The name of attribute. attrUsage: The name of Usage of attribute. attrDataType: The data type of the attribute. attrDisplaySequence : The display sequence of the attribute. attrDescription: The description of the attribute.
CatalogEntryException
- A CatalogEntryException
is thrown if the
attributes could not be deleted.public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType[] catEntIds, CatalogGroupIdentifierType[] parentCatGrpIdentfiers) throws CatalogEntryException
CatalogEntryIdentifierType
. An array of
CatalogGroupIdentifierType
is to be passed that represent
the new parent catalog group of the corresponding catentries
.catEntIds
- parentCatGrpIdentfiers
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType addCatalogEntryParentCatGroup(CatalogEntryIdentifierType[] catEntIds, CatalogGroupIdentifierType[] parentCatGrpIdentfiers) throws CatalogEntryException
CatalogEntryIdentifierType
. An array of
CatalogGroupIdentifierType
is to be passed that represent
the new parent catalog group of the corresponding catentries
.catEntIds
- parentCatGrpIdentfiers
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntry(CatalogEntryIdentifierType[] catEntIds) throws CatalogEntryException
CatalogEntryIdentifierType
.catEntIds
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType catEntryId, CatalogGroupIdentifierType parentCatGrpIdentfier) throws CatalogEntryException
CatalogEntryIdentifierType
. The new parent catalog group
identifier is to be passed in CatalogGroupIdentifierType
An
array of CatalogGroupIdentifierType
is to be passed that
represent the new parent catalog group of the corresponding catentries
.catEntryId
- parentCatGrpIdentfier
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public AcknowledgeCatalogEntryDataAreaType createCatalogEntry(java.util.List catalogEntryList) throws CatalogEntryException
CatalogEntryType
objects containing the all the
information related to the catentry .catalogEntryList
- a list of CatalogEntryType
objects to be
created.AcknowledgeCatalogEntryDataAreaType
CatalogEntryException
public AcknowledgeCatalogEntryDataAreaType processCatalogEntry(java.lang.String[] actionArray, CatalogEntryType[] catentries, java.lang.String[] strXPaths) throws CatalogEntryException
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.CatalogEntryException
public java.util.Map updateCatalogEntry(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
Sample code to use the API:
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,
null);Map response = client.updateCatalogEntry(parameters);
String[] outCatEntryIds = (String[]) response.get("catEntryId");
parameters
- This contains the value(s) to be updated for the given
catalog EntryAbstractBusinessObjectDocumentException
public java.util.Map updateCatalogEntryParent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
Sample code to use the API:
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,
null);Map response = client.updateCatalogEntryParent(parameters);
String[] outCatEntryIds = (String[]) response.get("catEntryId");
parameters
- This contains the value(s) to be updated for the given
catalog EntryAbstractBusinessObjectDocumentException
public java.util.Map addCatalogEntryParent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
Sample code to use the API:
CatalogEntryFacadeClient client = new CatalogEntryFacadeClient(businessContext,
null);Map response = client.updateCatalogEntryParent(parameters);
String[] outCatEntryIds = (String[]) response.get("catEntryId");
parameters
- This contains the value(s) to be updated for the given catalog
EntryAbstractBusinessObjectDocumentException
public java.util.Map updateSKUParent(java.util.Map parameters)
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. parentCategoryId: The name of the Catalog entry's Immediate Parent's Unique ID.
public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatEntry(CatalogEntryIdentifierType[] catEntIds, CatalogEntryIdentifierType[] parentCatEntryIdentfiers) throws CatalogEntryException
CatalogEntryIdentifierType
. An array of
CatalogGroupIdentifierType
is to be passed that represent
the new parent catalog group of the corresponding catentries
.catEntIds
- parentCatEntryIdentfiers
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatEntry(CatalogEntryIdentifierType catEntryId, CatalogEntryIdentifierType parentCatentryIdentfier) throws CatalogEntryException
CatalogEntryIdentifierType
. The new parent catalog group
identifier is to be passed in CatalogGroupIdentifierType
An array of CatalogGroupIdentifierType
is to be passed
that represent the new parent catalog group of the corresponding
catentries .catEntryId
- parentCatentryIdentfier
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatentry(CatalogEntryIdentifierType[] childCatEntIds, CatalogEntryIdentifierType[] parentCatentryIdentfiers, java.lang.String[] actions) throws CatalogEntryException
CatalogEntryIdentifierType
. An array of
CatalogGroupIdentifierType
is to be passed that represent
the new parent catalog group of the corresponding catentries
.childCatEntIds
- parentCatentryIdentfiers
- actions
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryNavigationRel(CatalogEntryType[] catalogEntriesWithChildren, java.lang.String[] actions) throws CatalogEntryException
catalogEntriesWithChildren
- The main noun, containing the navigation relationship type.actions
- The action code for each change required.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType[] catEntIds, CatalogGroupIdentifierType[] parentCatGrpIdentfiers, java.lang.String[] actions) throws CatalogEntryException
CatalogEntryIdentifierType
. An array of
CatalogGroupIdentifierType
is to be passed that represent
the new parent catalog group of the corresponding catentries
.catEntIds
- parentCatGrpIdentfiers
- actions
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public RespondCatalogEntryDataAreaType updateCatalogEntryParentCatGroup(CatalogEntryIdentifierType catEntryId, CatalogGroupIdentifierType parentCatGrpIdentfier, java.lang.String action) throws CatalogEntryException
CatalogEntryIdentifierType
. The new parent catalog group
identifier is to be passed in CatalogGroupIdentifierType
An array of CatalogGroupIdentifierType
is to be passed
that represent the new parent catalog group of the corresponding
catentries .catEntryId
- parentCatGrpIdentfier
- action
- RespondCatalogEntryDataAreaType
type.CatalogEntryException
public java.util.Map deleteCatalogEntryParent(java.util.Map parameters) throws AbstractBusinessObjectDocumentException
parameters
- This contains the keys that can be passed..
catentryId : The internal reference ids of the catalog entries to be updated. partnumber: The external reference ids of the catalog entries to be updated. parentCategoryId: The name of the Catalog entry's Immediate Parent's Unique ID.
AbstractBusinessObjectDocumentException
public GetCatalogEntryType createGetCatalogEntry()
GetBaseCatalogEntryType
object. This object will be associated with a container object to convert
the object into an XML document.GetBaseCatalogEntryType
object that is associated with a container.public ShowCatalogEntryDataAreaType getCatalogEntry(GetType getVerb) throws CatalogEntryException
ShowCatalogEntryDataAreaType
when
issuing the specified get expression to fetch base catalog entry. This
method will be used by other framworks or methods that constructs the get
expression.getCatalogEntry
in class AbstractCatalogFacadeClient
getVerb
- The get expression to execute.ShowCatalogEntryDataAreaType
response when
issuing the get expression.CatalogEntryException
- The CatalogEntryException
is thrown if error is foundpublic java.util.List getCatalogEntry(java.lang.String expressionLanguage, java.lang.String expression) throws CatalogEntryException
getCatalogEntry
in class AbstractCatalogFacadeClient
expressionLanguage
- The expression language.expression
- The expression to return a list of base catalog entries.CatalogEntryException
- The CatalogEntryException
is thrown if error is foundpublic 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
- The CatalogEntryException
is thrown if error is foundpublic RespondCatalogEntryDataAreaType updateCatalogEntryDescription(CatalogEntryType[] catEntries) throws CatalogEntryException
catEntries
- The catalog entries for which the description is to be updated.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
public java.util.Map updateDynamicKitPreConfiguration(java.util.Map parameters) throws CatalogEntryException, ECException, CatalogApplicationException
parameters
- This contains the dynamic kit pre configuration to be updated for the given
catalog entry.
catentryId : The internal reference id of the catalog entry to be updated. ConfigXML: The dynamic kit preconfiguration XML which is generated by the Sterling Configurator.
CatalogEntryException
ECException
CatalogApplicationException