com.ibm.commerce.content.facade.client

Class ContentFacadeClient

java.lang.Object

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

com.ibm.commerce.content.facade.client.AbstractContentFacadeClient

com.ibm.commerce.content.facade.client.ContentFacadeClient

public class ContentFacadeClient
extends AbstractContentFacadeClient

This class provides common methods that this and other utility classes in the Content facade can use. This class also provides a set of convenient Java APIs to represent particular Content operations. This set of Java APIs also includes 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
ContentFacadeClient() Creates an instance of the client to communicate with the Content facade.
ContentFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the Content facade.

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType	findAllExternalContent(java.lang.String externalContentType, java.lang.String accessProfile, java.lang.Integer maxItems, java.lang.Integer startNum) This method composes a Get BOD with an expression to find all the ExternalContent and sends the BOD to the ExternalContent-Server.
com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType	findExternalContentById(java.lang.String externalContentID, java.lang.String accessProfile) This method composes a Get BOD with an expression to find ExternalContent by ID and sends the BOD to the ExternalContent-Server.
com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType	findExternalContentByName(java.lang.String externalContentName, java.lang.String externalContentType, java.lang.String accessProfile, java.lang.Integer maxItems, java.lang.Integer startNum) This method composes a Get BOD with an expression to find ExternalContent by name and type, and sends the BOD to the ExternalContent-Server.
com.ibm.commerce.content.facade.datatypes.ShowTaskType	getTaskAllDetailsByStatus(java.lang.String status) This method returns all the information of all the tasks which are currently in the status passed to this method.
com.ibm.commerce.content.facade.datatypes.ShowTaskType	getTaskByID(java.lang.String taskID, java.lang.String accessProfile) This method returns the information of the task for which UniqueID is passed to this method.
com.ibm.commerce.content.facade.datatypes.ShowTaskType	getTaskByMultipleIDs(java.util.List taskIdList, java.lang.String accessProfile, java.lang.String pageSize, java.lang.String beginIndex) This method returns the information of all the tasks for which a list of UniqueIDs is passed to this method.
com.ibm.commerce.content.facade.datatypes.ShowTaskType	getTaskByStatus(java.lang.String status, java.lang.String accessProfile, java.lang.String pageSize, java.lang.String beginIndex) This method returns the summary information of all the tasks which are currently in the status passed to this method.
com.ibm.commerce.content.facade.datatypes.ShowTaskType	getTaskDetailsByStatus(java.lang.String status) This method returns the detailed information of all the tasks which are currently in the status passed to this method.
com.ibm.commerce.content.facade.datatypes.ShowTaskType	getTaskSummaryByStatus(java.lang.String status) This method returns the summary information of all the tasks which are currently in the status passed to this method.

Methods inherited from class com.ibm.commerce.content.facade.client.AbstractContentFacadeClient

changeAttachment, changeContentVersion, changeFileUploadJob, changeManagedDirectory, changeManagedFile, changeTask, changeTaskGroup, changeWorkspace, getAttachment, getAttachment, getAttachment, getContentVersion, getContentVersion, getContentVersion, getExternalContent, getExternalContent, getExternalContent, getFileUploadJob, getFileUploadJob, getFileUploadJob, getManagedDirectory, getManagedDirectory, getManagedDirectory, getManagedFile, getManagedFile, getManagedFile, getTask, getTask, getTask, getTaskGroup, getTaskGroup, getTaskGroup, getWorkspace, getWorkspace, getWorkspace, processAttachment, processContentVersion, processFileUploadJob, processManagedDirectory, processManagedFile, processTask, processTaskGroup, processWorkspace

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

ContentFacadeClient

public ContentFacadeClient()

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

ContentFacadeClient

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

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

Parameters:

businessContext - is the default business context to associate with the messages when making requests.

callbackHandler - is used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

getTaskSummaryByStatus

public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskSummaryByStatus(java.lang.String status)

This method returns the summary information of all the tasks which are currently in the status passed to this method.

Parameters:

status - Status of those tasks which needs to be returned.

Returns:

Returns an object of type ShowTaskType

getTaskDetailsByStatus

public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskDetailsByStatus(java.lang.String status)

This method returns the detailed information of all the tasks which are currently in the status passed to this method.

Parameters:

status - is the status of those tasks which need to be returned.

Returns:

Returns an object of type ShowTaskType

getTaskAllDetailsByStatus

public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskAllDetailsByStatus(java.lang.String status)

This method returns all the information of all the tasks which are currently in the status passed to this method.

Parameters:

status - Status of those tasks which need to be returned.

Returns:

Returns an object of type ShowTaskType

getTaskByStatus

public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskByStatus(java.lang.String status,
                                                                              java.lang.String accessProfile,
                                                                              java.lang.String pageSize,
                                                                              java.lang.String beginIndex)

This method returns the summary information of all the tasks which are currently in the status passed to this method.

Parameters:

status - Status of those tasks which need to be returned.

accessProfile - Access profile to scope the details of the returned tasks.

pageSize - Specifies number of records to be retrieved at a time.

beginIndex - Starting index.

Returns:

Returns an object of type ShowTaskType.

getTaskByID

public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskByID(java.lang.String taskID,
                                                                          java.lang.String accessProfile)

This method returns the information of the task for which UniqueID is passed to this method. This method accepts a single task UniqueID. Information returned is scoped according to the access profile paased to this method.

Parameters:

taskID - UniqueID of task.

accessProfile - Access profile to scope the details of the returned tasks.

Returns:

Returns an object of type ShowTaskType.

getTaskByMultipleIDs

public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskByMultipleIDs(java.util.List taskIdList,
                                                                                   java.lang.String accessProfile,
                                                                                   java.lang.String pageSize,
                                                                                   java.lang.String beginIndex)

This method returns the information of all the tasks for which a list of UniqueIDs is passed to this method. This method accepts multiple task UniqueIDs. Information returned is scoped according to the access profile paased to this method.

Parameters:

taskIdList - List of task UniqueIDs.

accessProfile - Access profile to scope the details of the returned tasks.

pageSize - Specifies number of records to be retrieved at a time.

beginIndex - Starting index.

Returns:

Returns an object of type ShowTaskType.

findExternalContentById

public com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType findExternalContentById(java.lang.String externalContentID,
                                                                                                         java.lang.String accessProfile)
                                                                                                  throws com.ibm.commerce.content.facade.client.ExternalContentException

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

Parameters:

externalContentID - the external content identifier

accessProfile - the access profile

Throws:

ExternalContentException

findExternalContentByName

public com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType findExternalContentByName(java.lang.String externalContentName,
                                                                                                           java.lang.String externalContentType,
                                                                                                           java.lang.String accessProfile,
                                                                                                           java.lang.Integer maxItems,
                                                                                                           java.lang.Integer startNum)
                                                                                                    throws com.ibm.commerce.content.facade.client.ExternalContentException

This method composes a Get BOD with an expression to find ExternalContent by name and type, and sends the BOD to the ExternalContent-Server.

Parameters:

externalContentName - the external content name to search by

externalContentType - the external content type to limit response items to (ex: ProductContent)

accessProfile - the access profile

maxItems - the maximum number of results to retrieve

startNum - the number from which to begin retrieving items

Throws:

ExternalContentException

findAllExternalContent

public com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType findAllExternalContent(java.lang.String externalContentType,
                                                                                                        java.lang.String accessProfile,
                                                                                                        java.lang.Integer maxItems,
                                                                                                        java.lang.Integer startNum)
                                                                                                 throws com.ibm.commerce.content.facade.client.ExternalContentException

This method composes a Get BOD with an expression to find all the ExternalContent and sends the BOD to the ExternalContent-Server. If the externalContentType parameter is specified as a value other than null, then the response is limited to external content type of that type (ex: ProductContent).

Parameters:

externalContentType - the external content type to limit response items to. Set to null to not filter by type.

accessProfile - the access profile

maxItems - the maximum number of results to retrieve

startNum - the number from which to begin retrieving items

Throws:

ExternalContentException