com.atlassian.jira.issue.fields.config.manager
Interface IssueTypeSchemeManager

All Known Implementing Classes:
IssueTypeSchemeManagerImpl

public interface IssueTypeSchemeManager

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


Method Summary
 void addOptionToDefault(java.lang.String id)
          Adds the option with the issue type id to the default issue type scheme
 FieldConfigScheme create(java.lang.String schemeName, java.lang.String schemeDescription, java.util.List optionIds)
           
 void deleteScheme(FieldConfigScheme configScheme)
           
 java.util.Collection getAllRelatedSchemes(java.lang.String optionId)
          Gets all schemes that has the issue type as part of its options
 java.util.List getAllSchemes()
           
 FieldConfigScheme getConfigScheme(org.ofbiz.core.entity.GenericValue project)
          Deprecated. Use of GenericValue is discouraged. Deprecated since: v4.0. Use getConfigScheme(Project) instead.
 FieldConfigScheme getConfigScheme(Project project)
          Returns a config scheme for a given project
 FieldConfigScheme getDefaultIssueTypeScheme()
          Returns the default global issue type, to which all issue types are added to
 IssueType getDefaultValue(FieldConfig config)
          Returns the IssueType object that is the default for thie configuration
 IssueType getDefaultValue(org.ofbiz.core.entity.GenericValue project)
          Returns the default IssueType object based on the passed in project.
 IssueType getDefaultValue(Issue issue)
           
 java.util.Collection<IssueType> getIssueTypesForDefaultScheme()
          Return the collection of issue types associated with the default scheme.
 java.util.Collection getIssueTypesForProject(org.ofbiz.core.entity.GenericValue project)
          Deprecated. Use of GenericValue is discouraged. Deprecated since: 3.9. Use getIssueTypesForProject(Project) instead.
 java.util.Collection<IssueType> getIssueTypesForProject(Project project)
          Return the collection of issue types associated with this project
 java.util.Collection<IssueType> getNonSubTaskIssueTypesForProject(Project project)
          Return the collection of issue types other than sub-tasks associated with this project.
 java.util.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(java.lang.String optionId)
           
 void setDefaultValue(FieldConfig config, java.lang.String optionId)
           
 FieldConfigScheme update(FieldConfigScheme configScheme, java.util.Collection optionIds)
           
 

Method Detail

create

FieldConfigScheme create(java.lang.String schemeName,
                         java.lang.String schemeDescription,
                         java.util.List optionIds)

update

FieldConfigScheme update(FieldConfigScheme configScheme,
                         java.util.Collection optionIds)

getDefaultIssueTypeScheme

FieldConfigScheme getDefaultIssueTypeScheme()
Returns the default global issue type, to which all issue types are added to

Returns:
FieldConfigScheme

isDefaultIssueTypeScheme

boolean isDefaultIssueTypeScheme(FieldConfigScheme configScheme)

addOptionToDefault

void addOptionToDefault(java.lang.String id)
Adds the option with the issue type id to the default issue type scheme

Parameters:
id - issue type id

getAllRelatedSchemes

java.util.Collection getAllRelatedSchemes(java.lang.String optionId)
Gets all schemes that has the issue type as part of its options

Parameters:
optionId - Issue type id being queried
Returns:
Collection of FieldConfigScheme objects

removeOptionFromAllSchemes

void removeOptionFromAllSchemes(java.lang.String optionId)

deleteScheme

void deleteScheme(FieldConfigScheme configScheme)

getAllSchemes

java.util.List getAllSchemes()

getDefaultValue

IssueType getDefaultValue(Issue issue)

getDefaultValue

IssueType getDefaultValue(FieldConfig config)
Returns the IssueType object that is the default for thie configuration

Parameters:
config -
Returns:
IssueType representing the default value of this config

setDefaultValue

void setDefaultValue(FieldConfig config,
                     java.lang.String optionId)

getDefaultValue

IssueType getDefaultValue(org.ofbiz.core.entity.GenericValue project)
Returns the default IssueType object based on the passed in project.

Parameters:
project -
Returns:
IssueType or null if there is no default

getConfigScheme

FieldConfigScheme getConfigScheme(org.ofbiz.core.entity.GenericValue project)
Deprecated. Use of GenericValue is discouraged. Deprecated since: v4.0. Use getConfigScheme(Project) instead.

Returns a config scheme for a given project

Parameters:
project -
Returns:
Relevent configscheme

getConfigScheme

FieldConfigScheme getConfigScheme(Project project)
Returns a config scheme for a given project

Parameters:
project -
Returns:
Relevent configscheme

getIssueTypesForProject

@NotNull
@Deprecated
java.util.Collection getIssueTypesForProject(org.ofbiz.core.entity.GenericValue project)
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

getIssueTypesForProject

@NotNull
java.util.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).

getIssueTypesForDefaultScheme

@NotNull
java.util.Collection<IssueType> getIssueTypesForDefaultScheme()
Return the collection of issue types associated with the default scheme.

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

getSubTaskIssueTypesForProject

@NotNull
java.util.Collection<IssueType> getSubTaskIssueTypesForProject(@NotNull
                                                                       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).

getNonSubTaskIssueTypesForProject

@NotNull
java.util.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:
collection of IssueType objects


Copyright © 2002-2010 Atlassian. All Rights Reserved.