Package com.lexmark.saperion.workflow

Interface WorkflowDefinitionService

All Superinterfaces:
com.lexmark.saperion.search.SearchExecutionService<WorkflowDefinitionListItemType>
All Known Implementing Classes:
AbstractWorkflowDefinitionDelegateService, WorkflowDefinitionDelegateService
public interface WorkflowDefinitionService extends com.lexmark.saperion.search.SearchExecutionService<WorkflowDefinitionListItemType>
This service provides functionality concerning workflow definitions.
Author:
jschwarz

  • Method Details

    • search

      com.lexmark.saperion.search.SearchResultPage<WorkflowDefinitionListItemType> search(com.lexmark.saperion.search.query.Statement statement, com.lexmark.saperion.search.PageDefinition pageDefinition) throws com.lexmark.saperion.exceptions.EcmException
      This method returns a list of references for every workflow definition in the system accessible from the current tenant.
      Specified by:
      search in interface com.lexmark.saperion.search.SearchExecutionService<WorkflowDefinitionListItemType>
      Returns:
      a list of every workflow definition in the system accessible from the current tenant
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getWorkflowDefinitionById

      WorkflowDefinitionType getWorkflowDefinitionById(WorkflowDefinitionReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException
      This method returns further information for a workflow process given by its reference.
      Parameters:
      reference - the workflow definition reference in base64 encoded form of {"name":"xxx"}
      Returns:
      further information for a workflow process given by its reference
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • startWorkflowProcess

      @Deprecated default WorkflowProcessReferenceType startWorkflowProcess(WorkflowDefinitionReferenceType workflowDefinitionReference, com.lexmark.saperion.document.DocumentReferenceType documentId, List<? extends com.lexmark.saperion.administration.ActorReferenceType> actors, String comment) throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use startWorkflowProcess(WorkflowDefinitionReferenceType, WorkflowStartInputType) instead
      This method starts a workflow process given a workflow definition and a document (by its id).
      Parameters:
      workflowDefinitionReference - a reference to the workflow definition to start
      documentId - the id of the document to start the process on
      actors - a list of the receivers of the next task, may be null depending on the workflow definition
      comment - a comment for the workflow process, may be null depending on the workflow definition
      Returns:
      a reference to the process that was started.
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • startWorkflowProcess

      WorkflowProcessReferenceType startWorkflowProcess(WorkflowDefinitionReferenceType reference, WorkflowStartInputType input) throws com.lexmark.saperion.exceptions.EcmException
      This method starts a workflow process given a workflow definition and a document (by its id).
      Parameters:
      reference - the workflow definition reference in base64 encoded form of {"name":"xxx"}
      input - the parameters for starting a workflow
      Returns:
      a reference to the process that was started.
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getInitialTransition

      TransitionDefinitionType getInitialTransition(WorkflowDefinitionReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException
      This method returns the initial transition definition for the referenced workflow. If the referenced workflow definition doesn't exist the method throws a ResourceNotFoundException. If the initial transition was not found the method returns null.
      Parameters:
      reference - the workflow definition reference in base64 encoded form of {"name":"xxx"}
      Returns:
      the initial transition of the referenced workflow or null if not present
      Throws:
      com.lexmark.saperion.exceptions.EcmException