Interface WorkflowLoopedTransitions

All Known Implementing Classes:
WorkflowLoopedTransitionsImpl

@Internal public interface WorkflowLoopedTransitions
Provides operations on workflow looped transitions. Looped transitions are those that exist on every status in a workflow and provide a mechanism to loop back to the status. This class deals with the business logic pertaining to creating, updating, deleting looped transitions, i.e. validation logic, persistence and dealing with ServiceOutcomes.
Since:
v7.4
  • Method Details

    • createLoopedTransition

      ServiceOutcome<TransitionData> createLoopedTransition(String loopedTransitionName, String loopedTransitionDescription, Long screenId, String workflowName)
      Create a looped transition to all statuses on a workflow. An error will be returned in the case of:
      • duplicate name of existing transition or global transition

      If the workflow is inactive it is modified directly, otherwise its draft is modified.

      Parameters:
      loopedTransitionName -
      loopedTransitionDescription -
      screenId -
      workflowName -
      Returns:
      A ServiceOutcome containing the transition data.
    • deleteLoopedTransition

      ServiceOutcome<Workflow> deleteLoopedTransition(int loopedTransitionId, String workflowName)
      Delete the looped transition in the specified workflow. This affects all statuses
      Parameters:
      loopedTransitionId - The looped transition to delete.
      workflowName - The workflow to delete the looped transition from.
      Returns:
      A ServiceOutcome containing the updated workflow.
    • updateLoopedTransition

      ServiceOutcome<Workflow> updateLoopedTransition(int transitionId, String name, String description, Long screenId, String workflowName)
      Update the global transition identified by the specified transition id with the supplied properties.
      Parameters:
      transitionId -
      name -
      description -
      screenId -
      workflowName -
      Returns:
      ServiceOutcome The updated workflow.
    • verifyLoopedTransitionCanBeAdded

      ServiceOutcome<Workflow> verifyLoopedTransitionCanBeAdded(String name, String workflowName, Long screenId)
    • verifyLoopedTransitionCanBeUpdated

      ServiceOutcome<Workflow> verifyLoopedTransitionCanBeUpdated(int transitionId, String name, String workflowName, Long screenId)