com.atlassian.jira.workflow.edit

Interface WorkflowStatuses

All Known Implementing Classes:

WorkflowStatusesImpl

@Internal
public interface WorkflowStatuses

Provides methods to operate on workflow statuses (e.g. create, delete).

Since:

7.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ICON_URL

Method Summary

Modifier and Type	Method and Description
ServiceOutcome<Workflow>	addStatusAndGlobalTransitionToWorkflow(Status status, String workflowName) Add a status and a global transition to that status to a workflow.
ServiceOutcome<Workflow>	addStatusToWorkflow(Status status, String workflowName) Add a status to a workflow.
ServiceOutcome<Workflow>	createAndAddStatusToWorkflow(boolean createGlobalTransition, String description, String name, String statusCategoryId, String workflowName) Create a status and add it to a workflow.
ServiceOutcome<Status>	getStatus(String statusId, String workflowName)
ServiceOutcome<Collection<Status>>	getStatuses(String workflowName)
ServiceOutcome<Workflow>	removeStatus(String statusId, String workflowName) Remove the status represented by the supplied status from the named workflow.
ServiceOutcome<Workflow>	updateStatus(String description, String name, String statusCategoryId, String statusId, String workflowName) Update a status, setting its description, name, and status category.
ServiceOutcome<Pair<Workflow,Status>>	verifyStatusCanBeRemoved(Status status, String workflowName)
ServiceOutcome<Pair<Workflow,Status>>	verifyStatusCanBeRemoved(String statusId, String workflowName)

Field Detail

DEFAULT_ICON_URL

static final String DEFAULT_ICON_URL

See Also:

Constant Field Values

Method Detail

createAndAddStatusToWorkflow

ServiceOutcome<Workflow> createAndAddStatusToWorkflow(boolean createGlobalTransition,
                                                      String description,
                                                      String name,
                                                      String statusCategoryId,
                                                      String workflowName)

Create a status and add it to a workflow.

Parameters:

createGlobalTransition - Whether a global transition to the new status should also be created.

description - The status's description.

name - The status's name.

statusCategoryId - The ID of the status category to use.

workflowName - The name of the workflow to add the status to.

Returns:

ServiceOutcome The updated workflow.

addStatusAndGlobalTransitionToWorkflow

ServiceOutcome<Workflow> addStatusAndGlobalTransitionToWorkflow(Status status,
                                                                String workflowName)

Add a status and a global transition to that status to a workflow.

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

Parameters:

status - The status.

workflowName - The workflow's name.

Returns:

A ServiceOutcome containing the new workflow step.

addStatusToWorkflow

ServiceOutcome<Workflow> addStatusToWorkflow(Status status,
                                             String workflowName)

Add a status to a workflow.

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

Parameters:

status - The status.

workflowName - The workflow's name.

Returns:

A ServiceOutcome containing the updated workflow.

removeStatus

ServiceOutcome<Workflow> removeStatus(String statusId,
                                      String workflowName)

Remove the status represented by the supplied status from the named workflow.

Parameters:

statusId -

workflowName -

Returns:

A ServiceOutcome containing the updated workflow.

updateStatus

ServiceOutcome<Workflow> updateStatus(String description,
                                      String name,
                                      String statusCategoryId,
                                      String statusId,
                                      String workflowName)

Update a status, setting its description, name, and status category.

Parameters:

description - The status's new description.

name - The status's new name.

statusCategoryId - The ID of the status's new category.

statusId - The status's ID.

workflowName - The name of the workflow to operate on.

Returns:

The updated workflow.

verifyStatusCanBeRemoved

ServiceOutcome<Pair<Workflow,Status>> verifyStatusCanBeRemoved(String statusId,
                                                               String workflowName)

verifyStatusCanBeRemoved

ServiceOutcome<Pair<Workflow,Status>> verifyStatusCanBeRemoved(@NotNull
                                                               Status status,
                                                               String workflowName)

getStatus

ServiceOutcome<Status> getStatus(String statusId,
                                 String workflowName)

getStatuses

ServiceOutcome<Collection<Status>> getStatuses(String workflowName)

Parameters:

workflowName -

Returns:

Information about all statuses in the system or error response if user can not edit specified workflow.