public interface

WorkflowScheme

com.atlassian.jira.workflow.WorkflowScheme
Known Indirect Subclasses

Class Overview

Represents the workflow scheme for JIRA.

Summary

Nested Classes
interface WorkflowScheme.Builder<T extends Builder<T>> A builder that can be used to change a workflow scheme. 
Public Methods
@Nonnull String getActualDefaultWorkflow()
Get the default workflow for the scheme.
@Nonnull String getActualWorkflow(String issueTypeId)
Returns the workflow to use given the passed issueTypeId.
String getConfiguredDefaultWorkflow()
Return the default workflow as saved in the database.
String getConfiguredWorkflow(String issueTypeId)
Return the Workflow for the passed IssueType as saved in the databse.
String getDescription()
The description of the workflow scheme.
Long getId()
The id of the workflow scheme.
@Nonnull Map<String, String> getMappings()
Returns a map of the form issueTypeId -> workflowName.
String getName()
The name of the workflow scheme.
boolean isDefault()
Is the scheme the system default.
boolean isDraft()
Is the scheme a draft.

Public Methods

@Nonnull public String getActualDefaultWorkflow ()

Get the default workflow for the scheme. Never null.

Returns
  • the default workflow for the scheme.

@Nonnull public String getActualWorkflow (String issueTypeId)

Returns the workflow to use given the passed issueTypeId.

Parameters
issueTypeId the issue type.
Returns
  • the workflow associated with the passed issue type. Never null.

public String getConfiguredDefaultWorkflow ()

Return the default workflow as saved in the database. Can return null if no default is stored.

Returns
  • the default workflow as configured in the database or null if no such default is configured.

public String getConfiguredWorkflow (String issueTypeId)

Return the Workflow for the passed IssueType as saved in the databse. Can return null if no Workflow is associated with the passed IssueType.

Returns
  • the Workflow associated with the passed workflow.

public String getDescription ()

The description of the workflow scheme.

Returns
  • the description of the workflow scheme.

public Long getId ()

The id of the workflow scheme. Will only be null when not stored.

Returns
  • the id of the workflow scheme.

@Nonnull public Map<String, String> getMappings ()

Returns a map of the form issueTypeId -> workflowName. The null issueTypeId is used to hold the value of the default workflow (if configured).

Returns
  • Returns a map of the form issueTypeId -> workflowName.

public String getName ()

The name of the workflow scheme.

Returns
  • the name of the workflow scheme.

public boolean isDefault ()

Is the scheme the system default.

Returns
  • true if this sceheme if the system default; false otherwise.

public boolean isDraft ()

Is the scheme a draft.

Returns
  • true if this sceheme is a draft; false otherwise.