com.ibm.commerce.infrastructure.facade.client

Class InfrastructureFacadeClient

java.lang.Object

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

com.ibm.commerce.infrastructure.facade.client.AbstractInfrastructureFacadeClient

com.ibm.commerce.infrastructure.facade.client.InfrastructureFacadeClient

public class InfrastructureFacadeClient
extends AbstractInfrastructureFacadeClient

This class provides common methods that this and other utility class to the Infrastructure facade can use. This class also provides a set of convenient Java API to represent particular Infrastructure 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 inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType	addDefaultCatalog(java.lang.String storeId, java.lang.String catalogId, java.util.Map<java.lang.String,java.lang.String> customFields) Creates the default catalog configuration for a store
com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType	addDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage) This method will communicate with the StorePage facade to add a default Store page layout association.
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType	addFolderItem(java.lang.String folderId, java.lang.String[] referenceId, java.lang.String[] folderItemType, java.lang.String[] storeId, java.util.List<java.util.Map> customFieldList) Add one or more folder items to a folder.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	addSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList) This method adds a list of SEO Properties for a given object with given page group for a given store.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	addSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList) This method adds a list of SEO URLs for a given object with given usage for a given store.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType	changeDefaultCatalog(java.lang.String store_id, java.lang.String storedefcat_id, java.util.Map<java.lang.String,java.lang.String> customFields) Changes the default catalog configuration for a store
RespondMarketingSpotType	changeFlow(ChangeMarketingSpotType aChangeFlow) This method will communicate with the MarketingSpot facade and send the specified ChangeMarketingSpot request for changing the flow.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	changeSEOProperties(java.lang.String storeId, java.lang.String[] actions, com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType[] seoPropertiesTypes, java.lang.String[] expressions) This method changes SEO Properties for a given store with the given actions and XPATH expressions.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	changeSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList, java.lang.String actionCode) This method changes a list of SEO Properties for a given object with given page group for a given store with the given action code.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	changeSEOURL(java.lang.String storeId, java.lang.String[] actions, com.ibm.commerce.foundation.common.datatypes.SEOURLType[] seoURLTypes, java.lang.String[] expressions) This method changes SEO URLs for a given store with the given actions and XPATH expressions.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	changeSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList, java.lang.String actionCode) This method changes a list of SEO URLs for a given object with given usage for a given store with the given action code.
com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType	closeStore(java.lang.String[] storeIds) This method composes a Process BOD with an Action of 'Close' and sends the BOD to WebSphere Commerce.
com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeFolderType	createFolder(java.lang.String identifier, java.lang.String usage, java.lang.String description, java.lang.String parentFolderId, java.lang.String storeId, java.util.Map customFieldMap) Creates a new folder.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType	deleteDefaultCatalog(java.lang.String storeId, java.lang.String storedefcatId) Deletes the default catalog configuration for the store
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	deleteSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList) This method deletes a list of SEO Properties for a given object with given page group for a given store.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	deleteSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList) This method deletes a list of SEO URLs for a given object with given usage for a given store.
ConfigurationType	findConfigurationById(java.lang.String uniqueId) This method composes a Get BOD with an expression to find a configuration by store ID and sends the BOD to the Infrastructure-Server.
OnlineStoreType	findStoreById(java.lang.String storeId, java.lang.String accessProfile) This method composes a Get BOD with an expression to find a store by ID and sends the BOD to the Infrastructure-Server.
java.lang.String	getConfigurationDescription(java.lang.String uniqueId) This method returns the description of the requested configuration.
java.lang.String	getConfigurationLanguageId(java.lang.String uniqueId) This method returns the description language Id of the requested configuration.
java.util.Map	getConfigurationUserData(java.lang.String uniqueId) This method returns the description language Id of the requested configuration.
java.lang.String	getConfigurationValue(java.lang.String uniqueId, java.lang.String configName) This method returns the value of a configuration attribute found in the requested configuration by store ID.
java.lang.String[]	getConfigurationValues(java.lang.String uniqueId, java.lang.String configName) This method returns the string array of values of a configuration attribute found in the requested configuration by store ID.
com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderDataAreaType	getFolderById(java.lang.String folderId, java.lang.String accessProfile) Gets a folder through folder unique id.
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType	moveFolder(java.lang.String folderId, java.lang.String parentFolderId) Moves an existing folder to a new location.
com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType	openStore(java.lang.String[] storeIds) This method composes a Process BOD with an Action of 'Open' and sends the BOD to WebSphere Commerce.
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType	removeFolderItem(java.lang.String folderId, java.lang.String[] folderItemId) Remove one or more folder items from a folder.
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType	removeFolderItem(java.lang.String folderId, java.lang.String[] referenceId, java.lang.String[] folderItemType) Remove one or more folder items from a folder.
void	reset() Reset the client to the initial state.
com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType	updateDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage) This method will communicate with the StorePage facade to update the default Store page layout association.
com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType	updateFolder(java.lang.String folderId, java.lang.String identifier, java.lang.String description, java.util.Map customFieldMap) Updates an existing folder.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	updateSEOProperties(java.lang.String storeId, java.lang.String objectId, java.lang.String pageGroup, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList) This method updates a list of SEO Properties for a given object with given page group for a given store.
com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType	updateSEOURL(java.lang.String storeId, java.lang.String objectId, java.lang.String usage, java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList) This method updates a list of SEO URLs for a given object with given usage for a given store.

Methods inherited from class com.ibm.commerce.infrastructure.facade.client.AbstractInfrastructureFacadeClient

changeFolder, changeOnlineStore, changePageLayout, changeStorePage, getConfiguration, getConfiguration, getConfiguration, getExternalRule, getExternalRule, getExternalRule, getFolder, getFolder, getFolder, getOnlineStore, getOnlineStore, getOnlineStore, getPageLayout, getPageLayout, getPageLayout, getStorePage, getStorePage, getStorePage, getStorePageData, getStorePageData, getStorePageData, processFolder, processOnlineStore

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

Constructor Detail

InfrastructureFacadeClient

public InfrastructureFacadeClient()

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

InfrastructureFacadeClient

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

Creates an instance of the client to communicate with the Infrastructure 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

closeStore

public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType closeStore(java.lang.String[] storeIds)

This method composes a Process BOD with an Action of 'Close' and sends the BOD to WebSphere Commerce.

Parameters:

storeIds - The store Ids to close.

Returns:

The Acknowledge BOD response.

openStore

public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeOnlineStoreType openStore(java.lang.String[] storeIds)

This method composes a Process BOD with an Action of 'Open' and sends the BOD to WebSphere Commerce.

Parameters:

storeIds - The store Ids to open.

Returns:

The Acknowledge BOD response.

findStoreById

public OnlineStoreType findStoreById(java.lang.String storeId,
                                     java.lang.String accessProfile)
                              throws OnlineStoreException

This method composes a Get BOD with an expression to find a store by ID and sends the BOD to the Infrastructure-Server.

Parameters:

storeId - The string containing the store Id.

accessProfile - The access profile.

Returns:

The OnlineStoreType object.

Throws:

OnlineStoreException - if an error is encountered.

findConfigurationById

public ConfigurationType findConfigurationById(java.lang.String uniqueId)
                                        throws ConfigurationException

This method composes a Get BOD with an expression to find a configuration by store ID and sends the BOD to the Infrastructure-Server.

Parameters:

uniqueId - The string containing configuration unique Id.

Returns:

The list of ConfigurationType object(s).

Throws:

ConfigurationException - if an error is encountered.

getConfigurationValue

public java.lang.String getConfigurationValue(java.lang.String uniqueId,
                                              java.lang.String configName)
                                       throws ConfigurationException

This method returns the value of a configuration attribute found in the requested configuration by store ID.

Parameters:

uniqueId - The unique Id representing the requested configuration.

configName - The configuration attribute name in the requested configuration.

Returns:

The value of the configuration attribute name.

Throws:

ConfigurationException - if an error is encountered.

getConfigurationValues

public java.lang.String[] getConfigurationValues(java.lang.String uniqueId,
                                                 java.lang.String configName)
                                          throws ConfigurationException

This method returns the string array of values of a configuration attribute found in the requested configuration by store ID.

Parameters:

uniqueId - The unique Id representing the requested configuration.

configName - The configuration attribute name in the requested configuration.

Returns:

The string array of values of the configuration attribute.

Throws:

ConfigurationException - if an error is encountered.

getConfigurationDescription

public java.lang.String getConfigurationDescription(java.lang.String uniqueId)
                                             throws ConfigurationException

This method returns the description of the requested configuration.

Parameters:

uniqueId - The unique Id representing the requested configuration.

Returns:

The description of the configuration.

Throws:

ConfigurationException - if an error is encountered.

getConfigurationLanguageId

public java.lang.String getConfigurationLanguageId(java.lang.String uniqueId)
                                            throws ConfigurationException

This method returns the description language Id of the requested configuration.

Parameters:

uniqueId - The unique Id representing the requested configuration.

Returns:

The description language Id of the configuration.

Throws:

ConfigurationException - if an error is encountered.

getConfigurationUserData

public java.util.Map getConfigurationUserData(java.lang.String uniqueId)
                                       throws ConfigurationException

This method returns the description language Id of the requested configuration.

Parameters:

uniqueId - The unique Id representing the requested configuration.

Returns:

The description language Id of the configuration.

Throws:

ConfigurationException - if an error is encountered.

reset

public void reset()

Reset the client to the initial state.

changeFlow

public RespondMarketingSpotType changeFlow(ChangeMarketingSpotType aChangeFlow)

This method will communicate with the MarketingSpot facade and send the specified ChangeMarketingSpot request for changing the flow.

Parameters:

aChangeFlow - The ChangeFlow request document.

Returns:

The resulting RespondMarketingSpot response document.

updateDefaultStorePageAssociation

public com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType updateDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)

This method will communicate with the StorePage facade to update the default Store page layout association.

Parameters:

aChangeStorePage - The ChangeStorePage request document.

Returns:

The resulting RespondStorePage response document.

addDefaultStorePageAssociation

public com.ibm.commerce.infrastructure.facade.datatypes.RespondStorePageType addDefaultStorePageAssociation(com.ibm.commerce.infrastructure.facade.datatypes.ChangeStorePageType aChangeStorePage)

This method will communicate with the StorePage facade to add a default Store page layout association.

Parameters:

aChangeStorePage - The ChangeStorePage request document.

Returns:

The resulting RespondStorePage response document.

addDefaultCatalog

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType addDefaultCatalog(java.lang.String storeId,
                                                                                                 java.lang.String catalogId,
                                                                                                 java.util.Map<java.lang.String,java.lang.String> customFields)

Creates the default catalog configuration for a store

Parameters:

storeId - The store id for which the default catalogId need to be set

catalogId - The catalog id that need to be set ad default for the store

customFields - The custom fields ("Field1", "Field2" and "Field3") of the default catalog. Field 1 is integer and Field 2 and Field 3 are string.

Returns:

The response of the request

changeDefaultCatalog

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType changeDefaultCatalog(java.lang.String store_id,
                                                                                                    java.lang.String storedefcat_id,
                                                                                                    java.util.Map<java.lang.String,java.lang.String> customFields)

Changes the default catalog configuration for a store

Parameters:

store_id - The store id of the current store

storedefcat_id - The primary key of the STOREDEFCAT table

customFields - The custom fields ("Field1", "Field2" and "Field3") of the default catalog. Field 1 is integer and Field 2 and Field 3 are string.

Returns:

The response of the request

deleteDefaultCatalog

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreType deleteDefaultCatalog(java.lang.String storeId,
                                                                                                    java.lang.String storedefcatId)

Deletes the default catalog configuration for the store

Parameters:

storeId - The store id whose default catalogId configuration need to be deleted.

storedefcatId - The primary key of the STOREDEFCAT table.

Returns:

The response of the request

removeFolderItem

public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType removeFolderItem(java.lang.String folderId,
                                                                                           java.lang.String[] referenceId,
                                                                                           java.lang.String[] folderItemType)

Remove one or more folder items from a folder. A single folder item will be removed from the specified folder for each value in the array of each input parameter. For example at index 0 of each input parameter will be the values to remove the first folder item, and at index 1 will be the values to remove the second folder item.

Parameters:

folderId - The unique ID of the folder to remove the folder item from.

referenceId - The unique IDs of the objects these folder items reference, such as the px_promotion_id in the case these folder items references a promotion.

folderItemType - The type of objects these folder items reference. For example "Promotion" if these folder items reference a promotion.

Returns:

A RespondFolderType holding a BOD containing all the folder items removed from the specified folder.

removeFolderItem

public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType removeFolderItem(java.lang.String folderId,
                                                                                           java.lang.String[] folderItemId)

Remove one or more folder items from a folder. A single folder item will be removed from the specified folder for each value in the array of each input parameter. For example at index 0 of each input parameter will be the values to remove the first folder item, and at index 1 will be the values to remove the second folder item.

Parameters:

folderId - The unique ID of the folder to remove the folder item from.

folderItemId - The unique IDs of the folder items to remove from this folder.

Returns:

A RespondFolderType holding a BOD containing all the folder items removed from the specified folder.

addFolderItem

public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType addFolderItem(java.lang.String folderId,
                                                                                        java.lang.String[] referenceId,
                                                                                        java.lang.String[] folderItemType,
                                                                                        java.lang.String[] storeId,
                                                                                        java.util.List<java.util.Map> customFieldList)

Add one or more folder items to a folder. A single folder item will be added to the specified folder for each value in the array of each input parameter. For example at index 0 of each input parameter will be the values to make the first folder item, and at index 1 will be the values to make the second folder item.

Parameters:

folderId - The unique ID of the folder to add the folder item too.

referenceId - The unique ID of the objects this folder item references, such as the px_promotion_id in the case this folder item references a promotion.

folderItemType - The type of object this folder item references. For example "Promotion" if this folder item references a promotion.

storeId - The unique ID of the store that owns the object being referenced. For example, if this folder item is referencing a promotion that is owned by store 10101 then this storeId must also be 10101.

customFieldList - A list of maps where each map holds the values for field1, field2, and field3 to put into the FOLDERITEM table for a folder item.

Returns:

A RespondFolderType holding a BOD containing all the folder items created in the specified folder.

createFolder

public com.ibm.commerce.infrastructure.facade.datatypes.AcknowledgeFolderType createFolder(java.lang.String identifier,
                                                                                           java.lang.String usage,
                                                                                           java.lang.String description,
                                                                                           java.lang.String parentFolderId,
                                                                                           java.lang.String storeId,
                                                                                           java.util.Map customFieldMap)

Creates a new folder.

Parameters:

identifier - The identifier of the folder to be created.

usage - The usage of the folder to be created. For example, "IBM_PromotionFolder", "IBM_AttributeFolder", "IBM_ActivityFolder", "IBM_EMarketingSpotFolder", "IBM_CustomerSegmentFolder", "IBM_ContentFolder".

description - The description of the folder.

parentFolderId - The unique id of the parent folder. Null means this folder is a top folder.

storeId - The unique id of the store this folder belongs to.

customFieldMap - A map holds the values for field1, field2, and field3 to put into the FOLDER table for a folder. Null means no changes to custom fields.

Returns:

A AcknowledgeFolderType holding a BOD containing the new folder created.

updateFolder

public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType updateFolder(java.lang.String folderId,
                                                                                       java.lang.String identifier,
                                                                                       java.lang.String description,
                                                                                       java.util.Map customFieldMap)

Updates an existing folder. Use this method to update the folder identifier, description and custom fields.

Parameters:

folderId - The unique id of the folder to be update.

identifier - The new identifier of the folder. Null means no change to identifier

description - The new description of the folder. Null means on change to description.

customFieldMap - A map holds the values for field1, field2, and field3 to put into the FOLDER table for a folder. Null means no changes to custom fields.

Returns:

A RespondFolderType holding a BOD containing all the folder items created in the specified folder.

moveFolder

public com.ibm.commerce.infrastructure.facade.datatypes.RespondFolderType moveFolder(java.lang.String folderId,
                                                                                     java.lang.String parentFolderId)

Moves an existing folder to a new location. Use this method to move folder from one parent to another parent.

Parameters:

folderId - The unique id of the folder to be moved.

parentFolderId - The unique id of the new parent folder. Null means move folder as top folder.

Returns:

A RespondFolderType holding a BOD containing the folder moved.

getFolderById

public com.ibm.commerce.infrastructure.facade.datatypes.ShowFolderDataAreaType getFolderById(java.lang.String folderId,
                                                                                             java.lang.String accessProfile)
                                                                                      throws com.ibm.commerce.infrastructure.facade.client.FolderException

Gets a folder through folder unique id.

Parameters:

folderId - The unique id of the folders to get.

accessProfile - The access profile.

Returns:

A ShowFolderDataAreaType holding a BOD containing the folder to get.

Throws:

FolderException - The FolderException is thrown if error information is found in the specified ShowFolderDataArea. This will represent that there was a problem when performing the operation.

addSEOURL

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType addSEOURL(java.lang.String storeId,
                                                                                                 java.lang.String objectId,
                                                                                                 java.lang.String usage,
                                                                                                 java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList)
                                                                                          throws OnlineStoreException

This method adds a list of SEO URLs for a given object with given usage for a given store. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO URLs belongs to.

usage - The usage type of the SEO URLs.

seoURLTypeList - The list of SEO URLs to be added.

Returns:

The RespondOnlineStoreDataAreaType containing the added SEO URLs.

Throws:

OnlineStoreException

updateSEOURL

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType updateSEOURL(java.lang.String storeId,
                                                                                                    java.lang.String objectId,
                                                                                                    java.lang.String usage,
                                                                                                    java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList)
                                                                                             throws OnlineStoreException

This method updates a list of SEO URLs for a given object with given usage for a given store. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO URLs belongs to.

usage - The usage type of the SEO URLs.

seoURLTypeList - The list of SEO URLs to be updated.

Returns:

The RespondOnlineStoreDataAreaType containing the updated SEO URLs.

Throws:

OnlineStoreException

deleteSEOURL

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType deleteSEOURL(java.lang.String storeId,
                                                                                                    java.lang.String objectId,
                                                                                                    java.lang.String usage,
                                                                                                    java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList)
                                                                                             throws OnlineStoreException

This method deletes a list of SEO URLs for a given object with given usage for a given store. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO URLs belongs to.

usage - The usage type of the SEO URLs.

seoURLTypeList - The list of SEO URLs to be deleted.

Returns:

The RespondOnlineStoreDataAreaType containing the deleted SEO URLs.

Throws:

OnlineStoreException

changeSEOURL

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOURL(java.lang.String storeId,
                                                                                                    java.lang.String objectId,
                                                                                                    java.lang.String usage,
                                                                                                    java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOURLType> seoURLTypeList,
                                                                                                    java.lang.String actionCode)
                                                                                             throws OnlineStoreException

This method changes a list of SEO URLs for a given object with given usage for a given store with the given action code. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store id.

objectId - The Object Id for which the SEO URLs belongs to.

usage - The usage type of the SEO URLs.

seoURLTypeList - The list of SEO URLs to be changed.

actionCode - The action code to operate on the SEO URLs (Add, Change, Delete).

Returns:

The RespondOnlineStoreDataAreaType containing the changed SEO URLs.

Throws:

OnlineStoreException

changeSEOURL

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOURL(java.lang.String storeId,
                                                                                                    java.lang.String[] actions,
                                                                                                    com.ibm.commerce.foundation.common.datatypes.SEOURLType[] seoURLTypes,
                                                                                                    java.lang.String[] expressions)
                                                                                             throws OnlineStoreException

This method changes SEO URLs for a given store with the given actions and XPATH expressions. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store id.

actions - The array of actions to operate on the SEO URLs.

seoURLTypes - The array of SEO URLs to be changed.

expressions - The array of request XPATH expressions for processing nouns.

Returns:

The RespondOnlineStoreDataAreaType containing the changed SEO URLs.

Throws:

OnlineStoreException

addSEOProperties

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType addSEOProperties(java.lang.String storeId,
                                                                                                        java.lang.String objectId,
                                                                                                        java.lang.String pageGroup,
                                                                                                        java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList)
                                                                                                 throws OnlineStoreException

This method adds a list of SEO Properties for a given object with given page group for a given store. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO Properties belongs to.

pageGroup - The Page Group of the Page Object.

seoPropertiesList - The list of SEO Properties to be added.

Returns:

The RespondOnlineStoreDataAreaType containing the added SEO Properties.

Throws:

OnlineStoreException

updateSEOProperties

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType updateSEOProperties(java.lang.String storeId,
                                                                                                           java.lang.String objectId,
                                                                                                           java.lang.String pageGroup,
                                                                                                           java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList)
                                                                                                    throws OnlineStoreException

This method updates a list of SEO Properties for a given object with given page group for a given store. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO Properties belongs to.

pageGroup - The Page Group of the Page Object.

seoPropertiesList - The list of SEO Properties to be updated.

Returns:

The RespondOnlineStoreDataAreaType containing the updated SEO Properties.

Throws:

OnlineStoreException

deleteSEOProperties

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType deleteSEOProperties(java.lang.String storeId,
                                                                                                           java.lang.String objectId,
                                                                                                           java.lang.String pageGroup,
                                                                                                           java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList)
                                                                                                    throws OnlineStoreException

This method deletes a list of SEO Properties for a given object with given page group for a given store. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO Properties belongs to.

pageGroup - The Page Group of the Page Object.

seoPropertiesList - The list of SEO Properties to be deleted.

Returns:

The RespondOnlineStoreDataAreaType containing the deleted SEO Properties.

Throws:

OnlineStoreException

changeSEOProperties

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOProperties(java.lang.String storeId,
                                                                                                           java.lang.String objectId,
                                                                                                           java.lang.String pageGroup,
                                                                                                           java.util.List<com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType> seoPropertiesList,
                                                                                                           java.lang.String actionCode)
                                                                                                    throws OnlineStoreException

This method changes a list of SEO Properties for a given object with given page group for a given store with the given action code. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store Id.

objectId - The Object Id for which the SEO Properties belongs to.

pageGroup - The Page Group of the Page Object.

seoPropertiesList - The list of SEO Properties to be changed.

actionCode - The action code to operate on the SEO Properties (Add, Change, Delete).

Returns:

The RespondOnlineStoreDataAreaType containing the changed SEO Properties.

Throws:

OnlineStoreException

changeSEOProperties

public com.ibm.commerce.infrastructure.facade.datatypes.RespondOnlineStoreDataAreaType changeSEOProperties(java.lang.String storeId,
                                                                                                           java.lang.String[] actions,
                                                                                                           com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType[] seoPropertiesTypes,
                                                                                                           java.lang.String[] expressions)
                                                                                                    throws OnlineStoreException

This method changes SEO Properties for a given store with the given actions and XPATH expressions. This method can only be used when SEO feature is enabled.

Parameters:

storeId - The store id.

actions - The array of actions to operate on the SEO Properties.

seoPropertiesTypes - The array of SEO Properties to be changed.

expressions - The array of request XPATH expressions for processing nouns.

Returns:

The RespondOnlineStoreDataAreaType containing the changed SEO Properties.

Throws:

OnlineStoreException