Package org.opencastproject.workflow.api

Interface WorkflowOperationResult

All Known Implementing Classes:
WorkflowOperationResultImpl
public interface WorkflowOperationResult
The result of a workflow operation.

  • Method Details

    • getMediaPackage

      MediaPackage getMediaPackage()
      Returns:
      The media package that results from the execution of a workflow operation.

    • getProperties

      Map<String,String> getProperties()
      Operations may optionally set properties on a workflow operation.
      Returns:
      The properties to set

    • setAction

      void setAction(WorkflowOperationResult.Action action)
      Sets the action to take.
      Parameters:
      action - the action

    • getAction

      WorkflowOperationResult.Action getAction()
      Operations may optionally request that the workflow be placed in a certain state.
      Returns:
      The action that the workflow service should take on this workflow instance.

    • setAllowsContinue

      void setAllowsContinue(boolean isContinuable)
      Specifies whether the operation should be continuable by the user.
      Parameters:
      isContinuable -

    • allowsContinue

      boolean allowsContinue()
      Returns true if this operation can be continued by the user from an optional hold state. This value is only considered if the action returned by this result equals WorkflowOperationResult.Action.PAUSE.
      Returns:
      true if a paused operation should be continuable

    • setAllowsAbort

      void setAllowsAbort(boolean isAbortable)
      Specifies whether the operation should be abortable by the user.
      Parameters:
      isAbortable -

    • allowsAbort

      boolean allowsAbort()
      Returns true if this operation can be canceled by the user from an optional hold state. This value is only considered if the action returned by this result equals WorkflowOperationResult.Action.PAUSE.
      Returns:
      true if a paused operation should be abortable

    • getTimeInQueue

      long getTimeInQueue()
      The number of milliseconds this operation sat in a queue before finishing.
      Returns:
      The time spent in a queue