Package com.lexmark.saperion.client.workflow

Interface WorkflowDefinitionClient

  • All Known Implementing Classes:
    WorkflowDefinitionClientImpl
    public interface WorkflowDefinitionClient
    This client provides functionality concerning workflow definitions.
    Author:
    jschwarz

    • Method Detail

      • load

        WorkflowDefinitionType load()
                     throws com.lexmark.saperion.exceptions.EcmException
        This method returns a representation of the workflow definition.
        Returns:
        the workflow definition representation.
        Throws:
        com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
        com.lexmark.saperion.exceptions.EcmException

      • getInitialTransition

        TransitionDefinitionType getInitialTransition()
                                       throws com.lexmark.saperion.exceptions.EcmException
        This method returns the initial transition definition for the workflow definition. The initial transition definition contains additional information which input must be provided in order to start a workflow process.
        Returns:
        the initial transition definition
        Throws:
        com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
        com.lexmark.saperion.exceptions.EcmException

      • startWorkflow

        default WorkflowProcessReferenceType startWorkflow​(com.lexmark.saperion.document.DocumentReferenceType documentReference,
                                                   java.lang.String comment)
                                            throws com.lexmark.saperion.exceptions.EcmException
        This method starts a workflow for the given document.
        Parameters:
        documentReference - the document for which the workflow is started.
        comment - the workflow start comment
        Returns:
        a reference to the new process
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • startWorkflow

        WorkflowProcessReferenceType startWorkflow​(com.lexmark.saperion.document.DocumentReferenceType document,
                                           java.lang.String comment,
                                           java.util.List<com.lexmark.saperion.administration.ActorReferenceType> actors)
                                    throws com.lexmark.saperion.exceptions.EcmException
        This method starts a workflow for the given document.
        Parameters:
        document - the document for which the workflow is started.
        actors - list of actors for the next workflow step
        comment - the workflow start comment
        Returns:
        a reference to the new process
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred