com.ibm.commerce.content.facade.client

Class AbstractContentFacadeClient

  • Direct Known Subclasses:
    AttachmentFacadeClient, ContentFacadeClient, ManagedDirectoryFacadeClient, ManagedFileFacadeClient

    public abstract class AbstractContentFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient

    This class provides a set of methods that can be used to communicate with the Content facade. This class represents a library of Content operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Content facade.

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      RespondAttachmentType changeAttachment(ChangeAttachmentType aChangeAttachment)
      This method will communicate with the Attachment facade and send the specified ChangeAttachment request.
      com.ibm.commerce.content.facade.datatypes.RespondContentVersionType changeContentVersion(com.ibm.commerce.content.facade.datatypes.ChangeContentVersionType aChangeContentVersion)
      This method will communicate with the ContentVersion facade and send the specified ChangeContentVersion request.
      RespondFileUploadJobType changeFileUploadJob(ChangeFileUploadJobType aChangeFileUploadJob)
      This method will communicate with the FileUploadJob facade and send the specified ChangeFileUploadJob request.
      RespondManagedDirectoryType changeManagedDirectory(ChangeManagedDirectoryType aChangeManagedDirectory)
      This method will communicate with the ManagedDirectory facade and send the specified ChangeManagedDirectory request.
      RespondManagedFileType changeManagedFile(ChangeManagedFileType aChangeManagedFile)
      This method will communicate with the ManagedFile facade and send the specified ChangeManagedFile request.
      com.ibm.commerce.content.facade.datatypes.RespondTaskType changeTask(com.ibm.commerce.content.facade.datatypes.ChangeTaskType aChangeTask)
      This method will communicate with the Task facade and send the specified ChangeTask request.
      com.ibm.commerce.content.facade.datatypes.RespondTaskGroupType changeTaskGroup(com.ibm.commerce.content.facade.datatypes.ChangeTaskGroupType aChangeTaskGroup)
      This method will communicate with the TaskGroup facade and send the specified ChangeTaskGroup request.
      com.ibm.commerce.content.facade.datatypes.RespondWorkspaceType changeWorkspace(com.ibm.commerce.content.facade.datatypes.ChangeWorkspaceType aChangeWorkspace)
      This method will communicate with the Workspace facade and send the specified ChangeWorkspace request.
      ShowAttachmentType getAttachment(GetAttachmentType aGetAttachment)
      This method will communicate with the Content facade and send the specified GetAttachment.
      ShowAttachmentDataAreaType getAttachment(GetType getVerb)
      This method returns the ShowAttachmentDataArea when issuing the specified get expression to fetch Attachments.
      java.util.List getAttachment(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of Attachments based on the expression specified.
      com.ibm.commerce.content.facade.datatypes.ShowContentVersionType getContentVersion(com.ibm.commerce.content.facade.datatypes.GetContentVersionType aGetContentVersion)
      This method will communicate with the Content facade and send the specified GetContentVersion.
      com.ibm.commerce.content.facade.datatypes.ShowContentVersionDataAreaType getContentVersion(GetType getVerb)
      This method returns the ShowContentVersionDataArea when issuing the specified get expression to fetch ContentVersions.
      java.util.List getContentVersion(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of ContentVersions based on the expression specified.
      com.ibm.commerce.content.facade.datatypes.ShowExternalContentType getExternalContent(com.ibm.commerce.content.facade.datatypes.GetExternalContentType aGetExternalContent)
      This method will communicate with the Content facade and send the specified GetExternalContent.
      com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType getExternalContent(GetType getVerb)
      This method returns the ShowExternalContentDataArea when issuing the specified get expression to fetch ExternalContents.
      java.util.List getExternalContent(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of ExternalContents based on the expression specified.
      ShowFileUploadJobType getFileUploadJob(GetFileUploadJobType aGetFileUploadJob)
      This method will communicate with the Content facade and send the specified GetFileUploadJob.
      ShowFileUploadJobDataAreaType getFileUploadJob(GetType getVerb)
      This method returns the ShowFileUploadJobDataArea when issuing the specified get expression to fetch FileUploadJobs.
      java.util.List getFileUploadJob(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of FileUploadJobs based on the expression specified.
      ShowManagedDirectoryType getManagedDirectory(GetManagedDirectoryType aGetManagedDirectory)
      This method will communicate with the Content facade and send the specified GetManagedDirectory.
      ShowManagedDirectoryDataAreaType getManagedDirectory(GetType getVerb)
      This method returns the ShowManagedDirectoryDataArea when issuing the specified get expression to fetch ManagedDirectorys.
      java.util.List getManagedDirectory(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of ManagedDirectorys based on the expression specified.
      ShowManagedFileType getManagedFile(GetManagedFileType aGetManagedFile)
      This method will communicate with the Content facade and send the specified GetManagedFile.
      ShowManagedFileDataAreaType getManagedFile(GetType getVerb)
      This method returns the ShowManagedFileDataArea when issuing the specified get expression to fetch ManagedFiles.
      java.util.List getManagedFile(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of ManagedFiles based on the expression specified.
      com.ibm.commerce.content.facade.datatypes.ShowTaskType getTask(com.ibm.commerce.content.facade.datatypes.GetTaskType aGetTask)
      This method will communicate with the Content facade and send the specified GetTask.
      com.ibm.commerce.content.facade.datatypes.ShowTaskDataAreaType getTask(GetType getVerb)
      This method returns the ShowTaskDataArea when issuing the specified get expression to fetch Tasks.
      java.util.List getTask(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of Tasks based on the expression specified.
      com.ibm.commerce.content.facade.datatypes.ShowTaskGroupType getTaskGroup(com.ibm.commerce.content.facade.datatypes.GetTaskGroupType aGetTaskGroup)
      This method will communicate with the Content facade and send the specified GetTaskGroup.
      com.ibm.commerce.content.facade.datatypes.ShowTaskGroupDataAreaType getTaskGroup(GetType getVerb)
      This method returns the ShowTaskGroupDataArea when issuing the specified get expression to fetch TaskGroups.
      java.util.List getTaskGroup(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of TaskGroups based on the expression specified.
      com.ibm.commerce.content.facade.datatypes.ShowWorkspaceDataAreaType getWorkspace(GetType getVerb)
      This method returns the ShowWorkspaceDataArea when issuing the specified get expression to fetch Workspaces.
      com.ibm.commerce.content.facade.datatypes.ShowWorkspaceType getWorkspace(com.ibm.commerce.content.facade.datatypes.GetWorkspaceType aGetWorkspace)
      This method will communicate with the Content facade and send the specified GetWorkspace.
      java.util.List getWorkspace(java.lang.String expressionLanguage, java.lang.String expression)
      This method returns a list of Workspaces based on the expression specified.
      AcknowledgeAttachmentType processAttachment(ProcessAttachmentType aProcessAttachment)
      This method will communicate with the Content facade and send the specified ProcessAttachment request.
      com.ibm.commerce.content.facade.datatypes.AcknowledgeContentVersionType processContentVersion(com.ibm.commerce.content.facade.datatypes.ProcessContentVersionType aProcessContentVersion)
      This method will communicate with the Content facade and send the specified ProcessContentVersion request.
      AcknowledgeFileUploadJobType processFileUploadJob(ProcessFileUploadJobType aProcessFileUploadJob)
      This method will communicate with the Content facade and send the specified ProcessFileUploadJob request.
      AcknowledgeManagedDirectoryType processManagedDirectory(ProcessManagedDirectoryType aProcessManagedDirectory)
      This method will communicate with the Content facade and send the specified ProcessManagedDirectory request.
      AcknowledgeManagedFileType processManagedFile(ProcessManagedFileType aProcessManagedFile)
      This method will communicate with the Content facade and send the specified ProcessManagedFile request.
      com.ibm.commerce.content.facade.datatypes.AcknowledgeTaskType processTask(com.ibm.commerce.content.facade.datatypes.ProcessTaskType aProcessTask)
      This method will communicate with the Content facade and send the specified ProcessTask request.
      com.ibm.commerce.content.facade.datatypes.AcknowledgeTaskGroupType processTaskGroup(com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType aProcessTaskGroup)
      This method will communicate with the Content facade and send the specified ProcessTaskGroup request.
      com.ibm.commerce.content.facade.datatypes.AcknowledgeWorkspaceType processWorkspace(com.ibm.commerce.content.facade.datatypes.ProcessWorkspaceType aProcessWorkspace)
      This method will communicate with the Content facade and send the specified ProcessWorkspace request.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractContentFacadeClient

        public AbstractContentFacadeClient()
        Creates an instance of the client to communicate with the Content facade.

      • AbstractContentFacadeClient

        public AbstractContentFacadeClient(BusinessContextType businessContext,
                                   javax.security.auth.callback.CallbackHandler callbackHandler)
        Creates an instance of the client to communicate with the Content 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

      • getAttachment

        public ShowAttachmentType getAttachment(GetAttachmentType aGetAttachment)
        This method will communicate with the Content facade and send the specified GetAttachment. request.
        Parameters:
        aGetAttachment - The GetAttachment request document.
        Returns:
        The resulting ShowAttachment response document.

      • processAttachment

        public AcknowledgeAttachmentType processAttachment(ProcessAttachmentType aProcessAttachment)
        This method will communicate with the Content facade and send the specified ProcessAttachment request.
        Parameters:
        aProcessAttachment - The ProcessAttachment request document.
        Returns:
        The resulting AcknowledgeAttachment response document.

      • changeAttachment

        public RespondAttachmentType changeAttachment(ChangeAttachmentType aChangeAttachment)
        This method will communicate with the Attachment facade and send the specified ChangeAttachment request.
        Parameters:
        aChangeAttachment - The ChangeAttachment request document.
        Returns:
        The resulting RespondAttachment response document.

      • getAttachment

        public ShowAttachmentDataAreaType getAttachment(GetType getVerb)
                                         throws AttachmentException
        This method returns the ShowAttachmentDataArea when issuing the specified get expression to fetch Attachments. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowAttachmentDataArea response when issuing the get expression.
        Throws:
        AttachmentException - The AttachmentException is thrown if error information is found in the specified ShowAttachmentDataArea. This will represent that there was a problem when performing the operation.

      • getAttachment

        public java.util.List getAttachment(java.lang.String expressionLanguage,
                                    java.lang.String expression)
                             throws AttachmentException
        This method returns a list of Attachments based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of Attachments.
        Returns:
        The list of Attachments that matches the expression specified.
        Throws:
        AttachmentException - The AttachmentException is thrown if error information is found in the specified ShowAttachmentDataArea. This will represent that there was a problem when performing the operation.

      • getManagedFile

        public ShowManagedFileType getManagedFile(GetManagedFileType aGetManagedFile)
        This method will communicate with the Content facade and send the specified GetManagedFile. request.
        Parameters:
        aGetManagedFile - The GetManagedFile request document.
        Returns:
        The resulting ShowManagedFile response document.

      • processManagedFile

        public AcknowledgeManagedFileType processManagedFile(ProcessManagedFileType aProcessManagedFile)
        This method will communicate with the Content facade and send the specified ProcessManagedFile request.
        Parameters:
        aProcessManagedFile - The ProcessManagedFile request document.
        Returns:
        The resulting AcknowledgeManagedFile response document.

      • changeManagedFile

        public RespondManagedFileType changeManagedFile(ChangeManagedFileType aChangeManagedFile)
        This method will communicate with the ManagedFile facade and send the specified ChangeManagedFile request.
        Parameters:
        aChangeManagedFile - The ChangeManagedFile request document.
        Returns:
        The resulting RespondManagedFile response document.

      • getManagedFile

        public ShowManagedFileDataAreaType getManagedFile(GetType getVerb)
                                           throws ManagedFileException
        This method returns the ShowManagedFileDataArea when issuing the specified get expression to fetch ManagedFiles. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowManagedFileDataArea response when issuing the get expression.
        Throws:
        ManagedFileException - The ManagedFileException is thrown if error information is found in the specified ShowManagedFileDataArea. This will represent that there was a problem when performing the operation.

      • getManagedFile

        public java.util.List getManagedFile(java.lang.String expressionLanguage,
                                     java.lang.String expression)
                              throws ManagedFileException
        This method returns a list of ManagedFiles based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of ManagedFiles.
        Returns:
        The list of ManagedFiles that matches the expression specified.
        Throws:
        ManagedFileException - The ManagedFileException is thrown if error information is found in the specified ShowManagedFileDataArea. This will represent that there was a problem when performing the operation.

      • getManagedDirectory

        public ShowManagedDirectoryType getManagedDirectory(GetManagedDirectoryType aGetManagedDirectory)
        This method will communicate with the Content facade and send the specified GetManagedDirectory. request.
        Parameters:
        aGetManagedDirectory - The GetManagedDirectory request document.
        Returns:
        The resulting ShowManagedDirectory response document.

      • processManagedDirectory

        public AcknowledgeManagedDirectoryType processManagedDirectory(ProcessManagedDirectoryType aProcessManagedDirectory)
        This method will communicate with the Content facade and send the specified ProcessManagedDirectory request.
        Parameters:
        aProcessManagedDirectory - The ProcessManagedDirectory request document.
        Returns:
        The resulting AcknowledgeManagedDirectory response document.

      • changeManagedDirectory

        public RespondManagedDirectoryType changeManagedDirectory(ChangeManagedDirectoryType aChangeManagedDirectory)
        This method will communicate with the ManagedDirectory facade and send the specified ChangeManagedDirectory request.
        Parameters:
        aChangeManagedDirectory - The ChangeManagedDirectory request document.
        Returns:
        The resulting RespondManagedDirectory response document.

      • getManagedDirectory

        public ShowManagedDirectoryDataAreaType getManagedDirectory(GetType getVerb)
                                                     throws ManagedDirectoryException
        This method returns the ShowManagedDirectoryDataArea when issuing the specified get expression to fetch ManagedDirectorys. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowManagedDirectoryDataArea response when issuing the get expression.
        Throws:
        ManagedDirectoryException - The ManagedDirectoryException is thrown if error information is found in the specified ShowManagedDirectoryDataArea. This will represent that there was a problem when performing the operation.

      • getManagedDirectory

        public java.util.List getManagedDirectory(java.lang.String expressionLanguage,
                                          java.lang.String expression)
                                   throws ManagedDirectoryException
        This method returns a list of ManagedDirectorys based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of ManagedDirectorys.
        Returns:
        The list of ManagedDirectorys that matches the expression specified.
        Throws:
        ManagedDirectoryException - The ManagedDirectoryException is thrown if error information is found in the specified ShowManagedDirectoryDataArea. This will represent that there was a problem when performing the operation.

      • getFileUploadJob

        public ShowFileUploadJobType getFileUploadJob(GetFileUploadJobType aGetFileUploadJob)
        This method will communicate with the Content facade and send the specified GetFileUploadJob. request.
        Parameters:
        aGetFileUploadJob - The GetFileUploadJob request document.
        Returns:
        The resulting ShowFileUploadJob response document.

      • processFileUploadJob

        public AcknowledgeFileUploadJobType processFileUploadJob(ProcessFileUploadJobType aProcessFileUploadJob)
        This method will communicate with the Content facade and send the specified ProcessFileUploadJob request.
        Parameters:
        aProcessFileUploadJob - The ProcessFileUploadJob request document.
        Returns:
        The resulting AcknowledgeFileUploadJob response document.

      • changeFileUploadJob

        public RespondFileUploadJobType changeFileUploadJob(ChangeFileUploadJobType aChangeFileUploadJob)
        This method will communicate with the FileUploadJob facade and send the specified ChangeFileUploadJob request.
        Parameters:
        aChangeFileUploadJob - The ChangeFileUploadJob request document.
        Returns:
        The resulting RespondFileUploadJob response document.

      • getFileUploadJob

        public ShowFileUploadJobDataAreaType getFileUploadJob(GetType getVerb)
                                               throws com.ibm.commerce.content.facade.client.FileUploadJobException
        This method returns the ShowFileUploadJobDataArea when issuing the specified get expression to fetch FileUploadJobs. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowFileUploadJobDataArea response when issuing the get expression.
        Throws:
        FileUploadJobException - The FileUploadJobException is thrown if error information is found in the specified ShowFileUploadJobDataArea. This will represent that there was a problem when performing the operation.

      • getFileUploadJob

        public java.util.List getFileUploadJob(java.lang.String expressionLanguage,
                                       java.lang.String expression)
                                throws com.ibm.commerce.content.facade.client.FileUploadJobException
        This method returns a list of FileUploadJobs based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of FileUploadJobs.
        Returns:
        The list of FileUploadJobs that matches the expression specified.
        Throws:
        FileUploadJobException - The FileUploadJobException is thrown if error information is found in the specified ShowFileUploadJobDataArea. This will represent that there was a problem when performing the operation.

      • getTask

        public com.ibm.commerce.content.facade.datatypes.ShowTaskType getTask(com.ibm.commerce.content.facade.datatypes.GetTaskType aGetTask)
        This method will communicate with the Content facade and send the specified GetTask. request.
        Parameters:
        aGetTask - The GetTask request document.
        Returns:
        The resulting ShowTask response document.

      • processTask

        public com.ibm.commerce.content.facade.datatypes.AcknowledgeTaskType processTask(com.ibm.commerce.content.facade.datatypes.ProcessTaskType aProcessTask)
        This method will communicate with the Content facade and send the specified ProcessTask request.
        Parameters:
        aProcessTask - The ProcessTask request document.
        Returns:
        The resulting AcknowledgeTask response document.

      • changeTask

        public com.ibm.commerce.content.facade.datatypes.RespondTaskType changeTask(com.ibm.commerce.content.facade.datatypes.ChangeTaskType aChangeTask)
        This method will communicate with the Task facade and send the specified ChangeTask request.
        Parameters:
        aChangeTask - The ChangeTask request document.
        Returns:
        The resulting RespondTask response document.

      • getTask

        public com.ibm.commerce.content.facade.datatypes.ShowTaskDataAreaType getTask(GetType getVerb)
                                                                       throws com.ibm.commerce.content.facade.client.TaskException
        This method returns the ShowTaskDataArea when issuing the specified get expression to fetch Tasks. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowTaskDataArea response when issuing the get expression.
        Throws:
        TaskException - The TaskException is thrown if error information is found in the specified ShowTaskDataArea. This will represent that there was a problem when performing the operation.

      • getTask

        public java.util.List getTask(java.lang.String expressionLanguage,
                              java.lang.String expression)
                       throws com.ibm.commerce.content.facade.client.TaskException
        This method returns a list of Tasks based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of Tasks.
        Returns:
        The list of Tasks that matches the expression specified.
        Throws:
        TaskException - The TaskException is thrown if error information is found in the specified ShowTaskDataArea. This will represent that there was a problem when performing the operation.

      • getTaskGroup

        public com.ibm.commerce.content.facade.datatypes.ShowTaskGroupType getTaskGroup(com.ibm.commerce.content.facade.datatypes.GetTaskGroupType aGetTaskGroup)
        This method will communicate with the Content facade and send the specified GetTaskGroup. request.
        Parameters:
        aGetTaskGroup - The GetTaskGroup request document.
        Returns:
        The resulting ShowTaskGroup response document.

      • processTaskGroup

        public com.ibm.commerce.content.facade.datatypes.AcknowledgeTaskGroupType processTaskGroup(com.ibm.commerce.content.facade.datatypes.ProcessTaskGroupType aProcessTaskGroup)
        This method will communicate with the Content facade and send the specified ProcessTaskGroup request.
        Parameters:
        aProcessTaskGroup - The ProcessTaskGroup request document.
        Returns:
        The resulting AcknowledgeTaskGroup response document.

      • changeTaskGroup

        public com.ibm.commerce.content.facade.datatypes.RespondTaskGroupType changeTaskGroup(com.ibm.commerce.content.facade.datatypes.ChangeTaskGroupType aChangeTaskGroup)
        This method will communicate with the TaskGroup facade and send the specified ChangeTaskGroup request.
        Parameters:
        aChangeTaskGroup - The ChangeTaskGroup request document.
        Returns:
        The resulting RespondTaskGroup response document.

      • getExternalContent

        public com.ibm.commerce.content.facade.datatypes.ShowExternalContentType getExternalContent(com.ibm.commerce.content.facade.datatypes.GetExternalContentType aGetExternalContent)
        This method will communicate with the Content facade and send the specified GetExternalContent. request.
        Parameters:
        aGetExternalContent - The GetExternalContent request document.
        Returns:
        The resulting ShowExternalContent response document.

      • getExternalContent

        public com.ibm.commerce.content.facade.datatypes.ShowExternalContentDataAreaType getExternalContent(GetType getVerb)
                                                                                             throws com.ibm.commerce.content.facade.client.ExternalContentException
        This method returns the ShowExternalContentDataArea when issuing the specified get expression to fetch ExternalContents. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowExternalContentDataArea response when issuing the get expression.
        Throws:
        ExternalContentException - The ExternalContentException is thrown if error information is found in the specified ShowExternalContentDataArea. This will represent that there was a problem when performing the operation.

      • getExternalContent

        public java.util.List getExternalContent(java.lang.String expressionLanguage,
                                         java.lang.String expression)
                                  throws com.ibm.commerce.content.facade.client.ExternalContentException
        This method returns a list of ExternalContents based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of ExternalContents.
        Returns:
        The list of ExternalContents that matches the expression specified.
        Throws:
        ExternalContentException - The ExternalContentException is thrown if error information is found in the specified ShowExternalContentDataArea. This will represent that there was a problem when performing the operation.

      • getTaskGroup

        public com.ibm.commerce.content.facade.datatypes.ShowTaskGroupDataAreaType getTaskGroup(GetType getVerb)
                                                                                 throws com.ibm.commerce.content.facade.client.TaskGroupException
        This method returns the ShowTaskGroupDataArea when issuing the specified get expression to fetch TaskGroups. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowTaskGroupDataArea response when issuing the get expression.
        Throws:
        TaskGroupException - The TaskGroupException is thrown if error information is found in the specified ShowTaskGroupDataArea. This will represent that there was a problem when performing the operation.

      • getTaskGroup

        public java.util.List getTaskGroup(java.lang.String expressionLanguage,
                                   java.lang.String expression)
                            throws com.ibm.commerce.content.facade.client.TaskGroupException
        This method returns a list of TaskGroups based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of TaskGroups.
        Returns:
        The list of TaskGroups that matches the expression specified.
        Throws:
        TaskGroupException - The TaskGroupException is thrown if error information is found in the specified ShowTaskGroupDataArea. This will represent that there was a problem when performing the operation.

      • getContentVersion

        public com.ibm.commerce.content.facade.datatypes.ShowContentVersionType getContentVersion(com.ibm.commerce.content.facade.datatypes.GetContentVersionType aGetContentVersion)
        This method will communicate with the Content facade and send the specified GetContentVersion. request.
        Parameters:
        aGetContentVersion - The GetContentVersion request document.
        Returns:
        The resulting ShowContentVersion response document.

      • processContentVersion

        public com.ibm.commerce.content.facade.datatypes.AcknowledgeContentVersionType processContentVersion(com.ibm.commerce.content.facade.datatypes.ProcessContentVersionType aProcessContentVersion)
        This method will communicate with the Content facade and send the specified ProcessContentVersion request.
        Parameters:
        aProcessContentVersion - The ProcessContentVersion request document.
        Returns:
        The resulting AcknowledgeContentVersion response document.

      • changeContentVersion

        public com.ibm.commerce.content.facade.datatypes.RespondContentVersionType changeContentVersion(com.ibm.commerce.content.facade.datatypes.ChangeContentVersionType aChangeContentVersion)
        This method will communicate with the ContentVersion facade and send the specified ChangeContentVersion request.
        Parameters:
        aChangeContentVersion - The ChangeContentVersion request document.
        Returns:
        The resulting RespondContentVersion response document.

      • getContentVersion

        public com.ibm.commerce.content.facade.datatypes.ShowContentVersionDataAreaType getContentVersion(GetType getVerb)
                                                                                           throws com.ibm.commerce.content.facade.client.ContentVersionException
        This method returns the ShowContentVersionDataArea when issuing the specified get expression to fetch ContentVersions. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowContentVersionDataArea response when issuing the get expression.
        Throws:
        ContentVersionException - The ContentVersionException is thrown if error information is found in the specified ShowContentVersionDataArea. This will represent that there was a problem when performing the operation.

      • getContentVersion

        public java.util.List getContentVersion(java.lang.String expressionLanguage,
                                        java.lang.String expression)
                                 throws com.ibm.commerce.content.facade.client.ContentVersionException
        This method returns a list of ContentVersions based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of ContentVersions.
        Returns:
        The list of ContentVersions that matches the expression specified.
        Throws:
        ContentVersionException - The ContentVersionException is thrown if error information is found in the specified ShowContentVersionDataArea. This will represent that there was a problem when performing the operation.

      • getWorkspace

        public com.ibm.commerce.content.facade.datatypes.ShowWorkspaceType getWorkspace(com.ibm.commerce.content.facade.datatypes.GetWorkspaceType aGetWorkspace)
        This method will communicate with the Content facade and send the specified GetWorkspace. request.
        Parameters:
        aGetWorkspace - The GetWorkspace request document.
        Returns:
        The resulting ShowWorkspace response document.

      • processWorkspace

        public com.ibm.commerce.content.facade.datatypes.AcknowledgeWorkspaceType processWorkspace(com.ibm.commerce.content.facade.datatypes.ProcessWorkspaceType aProcessWorkspace)
        This method will communicate with the Content facade and send the specified ProcessWorkspace request.
        Parameters:
        aProcessWorkspace - The ProcessWorkspace request document.
        Returns:
        The resulting AcknowledgeWorkspace response document.

      • changeWorkspace

        public com.ibm.commerce.content.facade.datatypes.RespondWorkspaceType changeWorkspace(com.ibm.commerce.content.facade.datatypes.ChangeWorkspaceType aChangeWorkspace)
        This method will communicate with the Workspace facade and send the specified ChangeWorkspace request.
        Parameters:
        aChangeWorkspace - The ChangeWorkspace request document.
        Returns:
        The resulting RespondWorkspace response document.

      • getWorkspace

        public com.ibm.commerce.content.facade.datatypes.ShowWorkspaceDataAreaType getWorkspace(GetType getVerb)
                                                                                 throws com.ibm.commerce.content.facade.client.WorkspaceException
        This method returns the ShowWorkspaceDataArea when issuing the specified get expression to fetch Workspaces. This method will be used by other framworks or methods that constructs the get expression.
        Parameters:
        getVerb - The get expression to execute.
        Returns:
        The ShowWorkspaceDataArea response when issuing the get expression.
        Throws:
        WorkspaceException - The WorkspaceException is thrown if error information is found in the specified ShowWorkspaceDataArea. This will represent that there was a problem when performing the operation.

      • getWorkspace

        public java.util.List getWorkspace(java.lang.String expressionLanguage,
                                   java.lang.String expression)
                            throws com.ibm.commerce.content.facade.client.WorkspaceException
        This method returns a list of Workspaces based on the expression specified.
        Parameters:
        expressionLanguage - The expression lanaguage.
        expression - The expression to return a list of Workspaces.
        Returns:
        The list of Workspaces that matches the expression specified.
        Throws:
        WorkspaceException - The WorkspaceException is thrown if error information is found in the specified ShowWorkspaceDataArea. This will represent that there was a problem when performing the operation.
Skip navigation links