Package com.atlassian.jira.workflow

Interface WorkflowScheme

All Known Subinterfaces:
AssignableWorkflowScheme, DraftWorkflowScheme
All Known Implementing Classes:
MockAssignableWorkflowScheme, MockDraftWorkflowScheme, MockWorkflowScheme
public interface WorkflowScheme
Represents the workflow scheme for JIRA.

  • Method Details

    • getId

      Long getId()
      The id of the workflow scheme. Will only be null when not stored.
      Returns:
      the id of the workflow scheme.

    • getName

      String getName()
      The name of the workflow scheme.
      Returns:
      the name of the workflow scheme.

    • getDescription

      String getDescription()
      The description of the workflow scheme.
      Returns:
      the description of the workflow scheme.

    • isDraft

      boolean isDraft()
      Is the scheme a draft.
      Returns:
      true if this sceheme is a draft; false otherwise.

    • isDefault

      boolean isDefault()
      Is the scheme the system default.
      Returns:
      true if this sceheme if the system default; false otherwise.

    • getActualWorkflow

      @Nonnull 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.

    • getActualDefaultWorkflow

      @Nonnull String getActualDefaultWorkflow()
      Get the default workflow for the scheme. Never null.
      Returns:
      the default workflow for the scheme.

    • getMappings

      @Nonnull 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.

    • getConfiguredDefaultWorkflow

      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.

    • getConfiguredWorkflow

      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.