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.
CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE
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.
|
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.
|
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
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb
public ContentFacadeClient()
public ContentFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
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.public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskSummaryByStatus(java.lang.String status)
status
- Status of those tasks which needs to be returned.ShowTaskType
public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskDetailsByStatus(java.lang.String status)
status
- is the status of those tasks which need to be returned.ShowTaskType
public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskAllDetailsByStatus(java.lang.String status)
status
- Status of those tasks which need to be returned.ShowTaskType
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)
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.ShowTaskType
.public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTaskByID(java.lang.String taskID, java.lang.String accessProfile)
taskID
- UniqueID of task.accessProfile
- Access profile to scope the details of the returned tasks.ShowTaskType
.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)
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.ShowTaskType
.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
externalContentID
- the external content identifieraccessProfile
- the access profileExternalContentException
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
externalContentName
- the external content name to search byexternalContentType
- the external content type to limit response items to (ex: ProductContent)accessProfile
- the access profilemaxItems
- the maximum number of results to retrievestartNum
- the number from which to begin retrieving itemsExternalContentException
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
externalContentType
parameter is specified as a value other than
null
, then the response is limited to external content type of that type (ex: ProductContent).externalContentType
- the external content type to limit response items to. Set to null
to not filter by type.accessProfile
- the access profilemaxItems
- the maximum number of results to retrievestartNum
- the number from which to begin retrieving itemsExternalContentException