Interface IWorkflowMedia

All Superinterfaces:
IDisposable, IEntity, IInteractionMedia

public interface IWorkflowMedia extends IInteractionMedia
Represents a workflow media.
  • Method Details

    • addWorkflowErrorListener

      void addWorkflowErrorListener(WorkflowErrorListener listener)
      Registers the WorkflowErrorListener.
      Parameters:
      listener - Event listener to add.
    • removeWorkflowErrorListener

      void removeWorkflowErrorListener(WorkflowErrorListener listener)
      Unregisters the WorkflowErrorListener.
      Parameters:
      listener - Event listener to remove.
    • addWorkflowListener

      void addWorkflowListener(WorkflowListener listener)
      Registers the WorkflowListener.
      Parameters:
      listener - Event listener to add.
    • removeWorkflowListener

      void removeWorkflowListener(WorkflowListener listener)
      Unregisters the WorkflowListener.
      Parameters:
      listener - Event listener to remove.
    • addWorkflowProgressListener

      void addWorkflowProgressListener(WorkflowProgressListener listener)
      Registers the WorkflowProgressListener.
      Parameters:
      listener - Event listener to add.
    • removeWorkflowProgressListener

      void removeWorkflowProgressListener(WorkflowProgressListener listener)
      Unregisters the WorkflowProgressListener.
      Parameters:
      listener - Event listener to remove.
    • endReservation

      void endReservation(boolean synchronous) throws Exception, altitude.integrationServer.exceptions.ISException
      Ends the workflow reservation.
      Parameters:
      synchronous - If true, the method is synchronous.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getAllowedOperations

      WorkflowMediaCanDo getAllowedOperations() throws Exception, altitude.integrationServer.exceptions.ISException
      Allowed operations.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getData

      WorkflowInteractionData getData() throws Exception, altitude.integrationServer.exceptions.ISException
      Data of the workflow interaction.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getIsSuspended

      boolean getIsSuspended() throws Exception, altitude.integrationServer.exceptions.ISException
      True if the interaction is suspended.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getNextTaskData

      WorkflowNextTaskData getNextTaskData() throws Exception, altitude.integrationServer.exceptions.ISException
      Next task data of the workflow.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • setNextTaskData

      void setNextTaskData(WorkflowNextTaskData value) throws Exception, altitude.integrationServer.exceptions.ISException
      Next task data of the workflow.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getScript

      ScriptInfo getScript() throws Exception, altitude.integrationServer.exceptions.ISException
      Information about the script.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getState

      WorkflowInteractionState getState() throws Exception, altitude.integrationServer.exceptions.ISException
      State of the workflow interaction.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getTaskName

      String getTaskName() throws Exception, altitude.integrationServer.exceptions.ISException
      Workflow task name.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getWasRecovered

      boolean getWasRecovered() throws Exception, altitude.integrationServer.exceptions.ISException
      True if the workflow was recovered.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getWorkflowDefinitionId

      int getWorkflowDefinitionId() throws Exception, altitude.integrationServer.exceptions.ISException
      Identifier of the workflow definition.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getWorkflowDefinitionName

      String getWorkflowDefinitionName() throws Exception, altitude.integrationServer.exceptions.ISException
      Name of the workflow definition.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getWorkflowNotes

      String getWorkflowNotes() throws Exception, altitude.integrationServer.exceptions.ISException
      Workflow notes.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getWorkflowProcessId

      int getWorkflowProcessId() throws Exception, altitude.integrationServer.exceptions.ISException
      Identifier of the workflow process.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getWorkflowProcessUniqueId

      String getWorkflowProcessUniqueId() throws Exception, altitude.integrationServer.exceptions.ISException
      Unique identifier of the workflow process.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException