Package com.lexmark.saperion.delegate

Class AbstractWorkflowInboxDelegateService

java.lang.Object
com.lexmark.saperion.delegate.AbstractDelegateService<WorkflowInboxService>
com.lexmark.saperion.delegate.AbstractWorkflowInboxDelegateService
All Implemented Interfaces:
com.lexmark.saperion.search.SearchExecutionService<InboxListItemType>, WorkflowInboxService
Direct Known Subclasses:
WorkflowInboxDelegateService
public abstract class AbstractWorkflowInboxDelegateService extends AbstractDelegateService<WorkflowInboxService> implements WorkflowInboxService
This WorkflowInboxService simply delegates to another instance.
Author:
jschwarz

  • Constructor Details

    • AbstractWorkflowInboxDelegateService

      public AbstractWorkflowInboxDelegateService()

  • Method Details

    • search

      public com.lexmark.saperion.search.SearchResultPage<InboxListItemType> search(com.lexmark.saperion.search.query.Statement statement, com.lexmark.saperion.search.PageDefinition pageDefinition) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: WorkflowInboxService
      This method returns a list of information about all inboxes of the current user. It can be filtered and is paged.
      Specified by:
      search in interface com.lexmark.saperion.search.SearchExecutionService<InboxListItemType>
      Specified by:
      search in interface WorkflowInboxService
      Parameters:
      statement - additional filter on the inboxes
      pageDefinition - the page of the result to return
      Returns:
      list of inboxes
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • newInboxTypeSearchService

      public com.lexmark.saperion.search.SearchExecutionService<InboxListItemType> newInboxTypeSearchService(InboxTypeEnumeration inboxType) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: WorkflowInboxService
      This method returns a search execution service that searches all inboxes of a specific type.
      Specified by:
      newInboxTypeSearchService in interface WorkflowInboxService
      Parameters:
      inboxType - the type to search for
      Returns:
      a search execution service that searches all inboxes of a specific type
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getInbox

      public InboxListItemType getInbox(InboxReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: WorkflowInboxService
      Returns the inbox with the specified ID.
      Specified by:
      getInbox in interface WorkflowInboxService
      Parameters:
      reference - the reference of the inbox in base64 encoded form of {"id":xxx}
      Returns:
      the inbox with the specified ID
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getPersonalInbox

      public InboxListItemType getPersonalInbox() throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: WorkflowInboxService
      Returns the personal inbox of the current user.
      Specified by:
      getPersonalInbox in interface WorkflowInboxService
      Returns:
      the personal inbox
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • newTaskSearchService

      public com.lexmark.saperion.search.SearchExecutionService<TaskListItemType> newTaskSearchService(InboxReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: WorkflowInboxService
      This method creates an new search execution service that searches tasks that are contained in the referenced workflow inbox.
      Specified by:
      newTaskSearchService in interface WorkflowInboxService
      Parameters:
      reference - a reference to the inbox to get the tasks for in base64 encoded form of {"id":xxx}
      Returns:
      a list of tasks
      Throws:
      com.lexmark.saperion.exceptions.system.SystemException - datasource not available workflow definition not available system error when retrieving tasks configuration error
      com.lexmark.saperion.exceptions.application.SearchException - database error when retrieving tasks
      com.lexmark.saperion.exceptions.EcmException