Package org.opencastproject.workflow.api

Interface WorkflowOperationDefinition

All Superinterfaces:
Configurable
All Known Implementing Classes:
WorkflowOperationDefinitionImpl
public interface WorkflowOperationDefinition extends Configurable
Describes an operation or action to be performed as part of a workflow.

  • Method Details

    • getId

      String getId()

    • getDescription

      String getDescription()

    • getExceptionHandlingWorkflow

      String getExceptionHandlingWorkflow()
      The workflow to run if an exception is thrown while this operation is running.

    • isFailWorkflowOnException

      boolean isFailWorkflowOnException()
      If true, this workflow will be put into a failed (or failing, if getExceptionHandlingWorkflow() is not null) state when exceptions are thrown during an operation.

    • getExecutionCondition

      String getExecutionCondition()
      Returns either null or true to have the operation executed. Any other value is interpreted as false and will skip the operation.

      Usually, this will be a variable name such as ${foo}, which will be replaced with its acutal value once the workflow is executed.

      If both getExecuteCondition() and getSkipCondition return a non-null value, the execute condition takes precedence.

      Returns:
      the excecution condition.

    • getSkipCondition

      String getSkipCondition()
      Returns either null or true to have the operation skipped. Any other value is interpreted as false and will execute the operation.

      Usually, this will be a variable name such as ${foo}, which will be replaced with its actual value once the workflow is executed.

      If both getExecuteCondition() and getSkipCondition return a non-null value, the execute condition takes precedence.

      Returns:
      the excecution condition.

    • getRetryStrategy

      RetryStrategy getRetryStrategy()
      Return the retry strategy
      Returns:
      the retry strategy

    • getMaxAttempts

      int getMaxAttempts()
      Returns the number of attempts the workflow service will make to execute this operation.
      Returns:
      the maximum number of retries before failing