com.atlassian.jira.workflow.edit

Class WorkflowStatusesImpl

java.lang.Object

com.atlassian.jira.workflow.edit.WorkflowStatusesImpl

All Implemented Interfaces:

WorkflowStatuses

public class WorkflowStatusesImpl
extends Object
implements WorkflowStatuses

Field Summary

Fields inherited from interface com.atlassian.jira.workflow.edit.WorkflowStatuses

DEFAULT_ICON_URL

Constructor Summary

Constructors

Constructor and Description
WorkflowStatusesImpl(JiraAuthenticationContext authenticationContext, ConstantsService constantsService, StatusService statusService, Workflows workflows, StatusManager statusManager, WorkflowService workflowService, OutcomeHelper outcomeHelper, WorkflowStatusesValidator workflowStatusesValidator)

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowStatusesImpl

public WorkflowStatusesImpl(JiraAuthenticationContext authenticationContext,
                            ConstantsService constantsService,
                            StatusService statusService,
                            Workflows workflows,
                            StatusManager statusManager,
                            WorkflowService workflowService,
                            OutcomeHelper outcomeHelper,
                            WorkflowStatusesValidator workflowStatusesValidator)

Method Detail

createAndAddStatusToWorkflow

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

Description copied from interface: WorkflowStatuses

Create a status and add it to a workflow.

Specified by:

createAndAddStatusToWorkflow in interface WorkflowStatuses

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

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

Description copied from interface: WorkflowStatuses

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.

Specified by:

addStatusAndGlobalTransitionToWorkflow in interface WorkflowStatuses

Parameters:

status - The status.

workflowName - The workflow's name.

Returns:

A ServiceOutcome containing the new workflow step.

addStatusToWorkflow

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

Description copied from interface: WorkflowStatuses

Add a status to a workflow.

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

Specified by:

addStatusToWorkflow in interface WorkflowStatuses

Parameters:

status - The status.

workflowName - The workflow's name.

Returns:

A ServiceOutcome containing the updated workflow.

removeStatus

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

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

Specified by:

removeStatus in interface WorkflowStatuses

Parameters:

statusId -

workflowName -

Returns:

A ServiceOutcome containing the updated workflow.

updateStatus

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

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

Specified by:

updateStatus in interface WorkflowStatuses

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

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

Specified by:

verifyStatusCanBeRemoved in interface WorkflowStatuses

verifyStatusCanBeRemoved

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

Specified by:

verifyStatusCanBeRemoved in interface WorkflowStatuses

getStatus

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

Specified by:

getStatus in interface WorkflowStatuses

getStatuses

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

Specified by:

getStatuses in interface WorkflowStatuses

Parameters:

workflowName -

Returns:

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