Package com.atlassian.jira.board

Interface BoardWorkflowService

All Known Implementing Classes:
DefaultBoardWorkflowService
@ExperimentalApi public interface BoardWorkflowService
Provides workflow-related service methods.
Since:
7.1

  • Method Details

    • getAccessibleStatuses

      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

    • getAllActiveWorkflowStatuses

      Set<Status> getAllActiveWorkflowStatuses()
      Get all active workflow statuses available in the instance.
      Returns:
      the set of statuses

    • getJiraWorkflows

      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

    • getJiraWorkflows

      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

    • getInitialStatusesForQuery

      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

    • getWorkflowsForQuery

      @NotNull @NotNull Collection<JiraWorkflow> getWorkflowsForQuery(@NotNull @NotNull ApplicationUser user, @NotNull @NotNull Query query)
      Given a user and query, return all JIRA workflows of issues in that query.
      Parameters:
      user - the user performing the search
      query - the query being asked about
      Returns:
      the collection of JIRA workflows