public interface

ProjectIssueTypeScreenSchemeHelper

com.atlassian.jira.issue.fields.screen.issuetype.ProjectIssueTypeScreenSchemeHelper
Known Indirect Subclasses

Class Overview

A number of useful issue type screen scheme scheme methods, particularly to do with "active" field screen schemes. A field screen scheme is only considered "active" if it is currently actually being used by a project. This means it is active if:

  1. The field screen scheme is mapped to an issue type in the project's scheme and the project has that issue type.
  2. The field screen scheme is a default for the project's scheme and there are some unmapped issue types.
Internal helper class for Project Configuration.

Summary

Public Methods
List<Project> getProjectsForFieldScreenScheme(FieldScreenScheme fieldScreenScheme)
Returns a list of the projects are currently using the passed screen scheme, and the screen scheme is active.
Multimap<FieldScreenSchemeProject> getProjectsForFieldScreenSchemes(Set<FieldScreenScheme> fieldScreenSchemes)
Like getProjectsForFieldScreenScheme(com.atlassian.jira.issue.fields.screen.FieldScreenScheme), but takes a set of field screen schemes and returns a multimap of Field Screen Scheme -> Active projects
List<Project> getProjectsForScheme(IssueTypeScreenScheme issueTypeScreenScheme)
Return a list of projects that use the issue type screen scheme with the passed query.

Public Methods

public List<Project> getProjectsForFieldScreenScheme (FieldScreenScheme fieldScreenScheme)

Returns a list of the projects are currently using the passed screen scheme, and the screen scheme is active. Only projects that the current user can change the configuration for will be returned.

Parameters
fieldScreenScheme the name of the field screen scheme to check.
Returns
  • a list of active projects. The list is sorted by project name. The list is mutable and can be changed by the caller safely.

public Multimap<FieldScreenSchemeProject> getProjectsForFieldScreenSchemes (Set<FieldScreenScheme> fieldScreenSchemes)

Like getProjectsForFieldScreenScheme(com.atlassian.jira.issue.fields.screen.FieldScreenScheme), but takes a set of field screen schemes and returns a multimap of Field Screen Scheme -> Active projects

Parameters
fieldScreenSchemes field screen schemes to get projects for
Returns

public List<Project> getProjectsForScheme (IssueTypeScreenScheme issueTypeScreenScheme)

Return a list of projects that use the issue type screen scheme with the passed query. Only projects that the passed user can change the configuration for will be returned.

Parameters
issueTypeScreenScheme the issue type screen scheme. There is no concept of a magical null-id issue type screen scheme, all of them, even the default, have IDs.
Returns
  • a list of projects that use the issue type screen scheme. The list is sorted by project name. The list is mutable and can be changed by the caller safely.