public interface

IssueTypeSchemeManager

com.atlassian.jira.issue.fields.config.manager.IssueTypeSchemeManager
Known Indirect Subclasses

Class Overview

A manager to manage IssueType's unique set of circumstances. That is, it circumvents the scheme system by collpasing the scheme and config

Summary

Public Methods
void addOptionToDefault(String id)
Adds the option with the issue type id to the default issue type scheme
FieldConfigScheme create(String schemeName, String schemeDescription, List optionIds)
void deleteScheme(FieldConfigScheme configScheme)
Collection getAllRelatedSchemes(String optionId)
Gets all schemes that has the issue type as part of its options
List<FieldConfigScheme> getAllSchemes()
FieldConfigScheme getConfigScheme(Project project)
Returns a config scheme for a given project
FieldConfigScheme getConfigScheme(GenericValue project)
This method is deprecated. Use of GenericValue is discouraged. Deprecated since: v4.0. Use getConfigScheme(Project) instead.
IssueType getDefaultIssueType(Project project)
Returns the default IssueType object based on the passed in project.
FieldConfigScheme getDefaultIssueTypeScheme()
Returns the default global issue type, to which all issue types are added to
IssueType getDefaultValue(Issue issue)
IssueType getDefaultValue(GenericValue project)
This method is deprecated. Use getDefaultIssueType(Project) instead. Since v5.2.
IssueType getDefaultValue(FieldConfig config)
Returns the IssueType object that is the default for thie configuration
@Nonnull Collection<IssueType> getIssueTypesForDefaultScheme()
Return the collection of issue types associated with the default scheme.
@Nonnull Collection<IssueType> getIssueTypesForProject(Project project)
Return the collection of issue types associated with this project
@Nonnull @Deprecated Collection<IssueType> getIssueTypesForProject(GenericValue project)
This method is deprecated. Use of GenericValue is discouraged. Deprecated since: 3.9. Use getIssueTypesForProject(Project) instead.
@Nonnull Collection<IssueType> getNonSubTaskIssueTypesForProject(Project project)
Return the collection of issue types other than sub-tasks associated with this project.
@Nonnull Collection<IssueType> getSubTaskIssueTypesForProject(Project project)
Return the collection of sub-task issue types associated with this project Join of the result of this method and getNonSubTaskIssueTypesForProject(com.atlassian.jira.project.Project) produces the same result as a call to getIssueTypesForProject(com.atlassian.jira.project.Project).
boolean isDefaultIssueTypeScheme(FieldConfigScheme configScheme)
void removeOptionFromAllSchemes(String optionId)
void setDefaultValue(FieldConfig config, String optionId)
FieldConfigScheme update(FieldConfigScheme configScheme, Collection optionIds)

Public Methods

public void addOptionToDefault (String id)

Adds the option with the issue type id to the default issue type scheme

Parameters
id issue type id

public FieldConfigScheme create (String schemeName, String schemeDescription, List optionIds)

public void deleteScheme (FieldConfigScheme configScheme)

public Collection getAllRelatedSchemes (String optionId)

Gets all schemes that has the issue type as part of its options

Parameters
optionId Issue type id being queried
Returns

public List<FieldConfigScheme> getAllSchemes ()

public FieldConfigScheme getConfigScheme (Project project)

Returns a config scheme for a given project

Returns
  • Relevent configscheme

public FieldConfigScheme getConfigScheme (GenericValue project)

This method is deprecated.
Use of GenericValue is discouraged. Deprecated since: v4.0. Use getConfigScheme(Project) instead.

Returns a config scheme for a given project

Returns
  • Relevent configscheme

public IssueType getDefaultIssueType (Project project)

Returns the default IssueType object based on the passed in project.

Parameters
project the Project
Returns
  • IssueType or null if there is no default

public FieldConfigScheme getDefaultIssueTypeScheme ()

Returns the default global issue type, to which all issue types are added to

Returns
  • FieldConfigScheme

public IssueType getDefaultValue (Issue issue)

public IssueType getDefaultValue (GenericValue project)

This method is deprecated.
Use getDefaultIssueType(Project) instead. Since v5.2.

Returns the default IssueType object based on the passed in project.

Returns
  • IssueType or null if there is no default

public IssueType getDefaultValue (FieldConfig config)

Returns the IssueType object that is the default for thie configuration

Returns
  • IssueType representing the default value of this config

@Nonnull public Collection<IssueType> getIssueTypesForDefaultScheme ()

Return the collection of issue types associated with the default scheme.

Returns
  • collection of IssueType objects (possibly empty, never null).

@Nonnull public Collection<IssueType> getIssueTypesForProject (Project project)

Return the collection of issue types associated with this project

Parameters
project project to return the issue types of
Returns
  • collection of IssueType objects (possibly empty, never null).

@Nonnull @Deprecated public Collection<IssueType> getIssueTypesForProject (GenericValue project)

This method is deprecated.
Use of GenericValue is discouraged. Deprecated since: 3.9. Use getIssueTypesForProject(Project) instead.

Return the collection of issue types associated with this project

Parameters
project project generic value
Returns
  • collection of issue type objects

@Nonnull public Collection<IssueType> getNonSubTaskIssueTypesForProject (Project project)

Return the collection of issue types other than sub-tasks associated with this project. Join of the result of this method and getSubTaskIssueTypesForProject(com.atlassian.jira.project.Project) produces the same result as a call to getIssueTypesForProject(com.atlassian.jira.project.Project).

Parameters
project project to return the issue types of
Returns

@Nonnull public Collection<IssueType> getSubTaskIssueTypesForProject (Project project)

Return the collection of sub-task issue types associated with this project Join of the result of this method and getNonSubTaskIssueTypesForProject(com.atlassian.jira.project.Project) produces the same result as a call to getIssueTypesForProject(com.atlassian.jira.project.Project).

Parameters
project project to return the issue types of
Returns
  • collection of IssueType objects (possibly empty, never null).

public boolean isDefaultIssueTypeScheme (FieldConfigScheme configScheme)

public void removeOptionFromAllSchemes (String optionId)

public void setDefaultValue (FieldConfig config, String optionId)

public FieldConfigScheme update (FieldConfigScheme configScheme, Collection optionIds)