com.atlassian.jira.workflow.edit

Interface WorkflowTransitions

All Known Implementing Classes:

WorkflowTransitionsImpl

@Internal
public interface WorkflowTransitions

Provides operations on workflow transitions. This class deals with the business logic pertaining to creating, updating, deleting transitions, i.e. validation logic, persistence and dealing with ServiceOutcomes.

Since:

7.4

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Workflow>	addCommonTransition(String sourceStatusId, int transitionId, String workflowName) Add a common transition to a workflow.
ServiceOutcome<TransitionData>	addTransitionToWorkflow(String name, String description, Long screenId, int sourceStepId, int targetStepId, String workflowName) Add a transition with the specified properties to the named workflow.
ServiceOutcome<Workflow>	deleteTransition(int transitionId, int sourceStepId, String workflowName) Delete the transition represented by transition id on the specified workflow.
ServiceOutcome<Workflow>	updateTransition(int transitionId, String name, String description, Long screenId, int sourceStepId, String workflowName) Update an existing transition with the supplied properties on the named workflow.
ServiceOutcome<Workflow>	updateTransitionSource(int transitionId, String newSourceStatusId, String originalSourceStatusId, String workflowName) Update the source of an existing transition on the named workflow.
ServiceOutcome<Workflow>	updateTransitionTarget(int transitionId, String targetStatusId, String workflowName) Update the target of an existing transition on the named workflow.

Method Detail

addTransitionToWorkflow

ServiceOutcome<TransitionData> addTransitionToWorkflow(String name,
                                                       String description,
                                                       Long screenId,
                                                       int sourceStepId,
                                                       int targetStepId,
                                                       String workflowName)

Add a transition with the specified properties to the named workflow.

Returns:

ServiceOutcome New transition data.

updateTransition

ServiceOutcome<Workflow> updateTransition(int transitionId,
                                          String name,
                                          String description,
                                          Long screenId,
                                          int sourceStepId,
                                          String workflowName)

Update an existing transition with the supplied properties on the named workflow.

deleteTransition

ServiceOutcome<Workflow> deleteTransition(int transitionId,
                                          int sourceStepId,
                                          String workflowName)

Delete the transition represented by transition id on the specified workflow.

Parameters:

transitionId -

sourceStepId -

workflowName -

Returns:

ServiceOutcome

updateTransitionTarget

ServiceOutcome<Workflow> updateTransitionTarget(int transitionId,
                                                String targetStatusId,
                                                String workflowName)

Update the target of an existing transition on the named workflow.

updateTransitionSource

ServiceOutcome<Workflow> updateTransitionSource(int transitionId,
                                                String newSourceStatusId,
                                                String originalSourceStatusId,
                                                String workflowName)

Update the source of an existing transition on the named workflow.

Parameters:

transitionId - The id of the transition being modified.

newSourceStatusId - The status id representing the new source status.

originalSourceStatusId - The status id representing the original source status.

workflowName - The name of the workflow the transition exists on.

Returns:

ServiceOutcome The result of the update source action.

addCommonTransition

ServiceOutcome<Workflow> addCommonTransition(String sourceStatusId,
                                             int transitionId,
                                             String workflowName)

Add a common transition to a workflow.

Parameters:

sourceStatusId - The ID of the source status to use.

transitionId - The ID of the transition to use.

workflowName - The name of the workflow to add the common transition to.

Returns:

transitionId