@ExperimentalApi public interface

BoardWorkflowService

com.atlassian.jira.board.BoardWorkflowService
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

Provides workflow-related service methods.

Summary

Public Methods
Set<Status> getAccessibleStatuses(ApplicationUser user, Query query)
Get the set of accessible statuses for issues potentially returned by the current query.
Set<Status> getAllActiveWorkflowStatuses()
Get all active workflow statuses available in the instance.
Set<Status> getInitialStatusesForQuery(ApplicationUser user, Query query)
Given a user and query, return the set of initial statuses of all workflows of issues in that query.
Collection<JiraWorkflow> getJiraWorkflows(Project projectObj, String issueTypeId)
Given a project and an issue type id, returns the JIRA Workflows which are associated to that project for that issue type.
Collection<JiraWorkflow> getJiraWorkflows(Project projectObj)
Given a project, returns all JIRA workflows which are associated to that project.

Public Methods

public Set<Status> getAccessibleStatuses (ApplicationUser user, Query query)

Get the set of accessible statuses for issues potentially returned by the current query. In effect we are asking: "What projects and issue types could be returned by this query for this user, and what statuses are linked to workflows assigned to those projects and issue types?"

Parameters
user the user who would be performing the search
query the query being asked about
Returns
  • the set of statuses

public Set<Status> getAllActiveWorkflowStatuses ()

Get all active workflow statuses available in the instance.

Returns
  • the set of statuses

public Set<Status> getInitialStatusesForQuery (ApplicationUser user, Query query)

Given a user and query, return the set of initial statuses of all workflows of issues in that query.

Parameters
user the user performing the search
query the query being asked about
Returns
  • the set of initial statuses

public Collection<JiraWorkflow> getJiraWorkflows (Project projectObj, String issueTypeId)

Given a project and an issue type id, returns the JIRA Workflows which are associated to that project for that issue type. Empty on error.

Parameters
projectObj the project to get workflows for
issueTypeId the issue type id to get workflows for
Returns
  • the collection of JIRA workflows

public Collection<JiraWorkflow> getJiraWorkflows (Project projectObj)

Given a project, returns all JIRA workflows which are associated to that project. Empty on error.

Parameters
projectObj the project to get all associated workflows for
Returns
  • the collection of JIRA workflows