com.atlassian.jira.issue.fields.config
Interface FieldConfigScheme

All Known Implementing Classes:

FieldConfigSchemeImpl, MockFieldConfigScheme

@PublicApi
public interface FieldConfigScheme

A field config scheme is a set of FieldConfig objects that has been associated to a particular set of IssueTypes and then associated to a series of contexts (JiraContextNode). Methods return List will generally return nulls unless specified.

Nested Class Summary

static class

FieldConfigScheme.Builder

Method Summary

Collection<String>	getAssociatedIssueTypeIds() Returns the associated Issue Types.
Collection<IssueType>	getAssociatedIssueTypeObjects() Returns the associated Issue Types.
Set<org.ofbiz.core.entity.GenericValue>	getAssociatedIssueTypes() Deprecated. Use getAssociatedIssueTypeObjects() instead. Since v6.1.
List<org.ofbiz.core.entity.GenericValue>	getAssociatedProjectCategories() Deprecated. since 5.2 use getAssociatedProjectCategoryObjects() instead
List<ProjectCategory>	getAssociatedProjectCategoryObjects() Deprecated. Project Category contexts are not supported in JIRA and will be removed from the API. Since v6.4.
List<Long>	getAssociatedProjectIds() The associated projectIds, or an empty list if none associated.
List<Project>	getAssociatedProjectObjects() The associated projects, or an empty list if none associated.
List<org.ofbiz.core.entity.GenericValue>	getAssociatedProjects() Deprecated. since 5.1 use getAssociatedProjectObjects() instead
Map<String,FieldConfig>	getConfigs() Returns a Map whose key is a String of issue types and the value is the FieldConfig for that issue type
org.apache.commons.collections.MultiMap	getConfigsByConfig() Returns a Map whose key is a FieldConfig and values are associated a Collection Issue Type GenericValue
List<JiraContextNode>	getContexts() Returns a list of JiraContextNode objects this scheme is relevent to
String	getDescription()
ConfigurableField	getField()
Long	getId()
String	getName()
FieldConfig	getOneAndOnlyConfig() Returns the one and only config for this scheme iff there's only one config associated
boolean	isAllIssueTypes()
boolean	isAllProjects()
boolean	isBasicMode()
boolean	isEnabled()
boolean	isGlobal()
boolean	isInContext(IssueContext issueContext)

Method Detail

getName

String getName()

getDescription

String getDescription()

getConfigs

Map<String,FieldConfig> getConfigs()

Returns a Map whose key is a String of issue types and the value is the FieldConfig for that issue type

Returns:

Map of FieldConfig keyed by name. Null if nothing associated

getId

Long getId()

getContexts

List<JiraContextNode> getContexts()

Returns a list of JiraContextNode objects this scheme is relevent to

Returns:

list of JiraContextNode. an empty list if no contexts

isInContext

boolean isInContext(IssueContext issueContext)

getAssociatedProjectCategories

@Deprecated
List<org.ofbiz.core.entity.GenericValue> getAssociatedProjectCategories()

Deprecated. since 5.2 use getAssociatedProjectCategoryObjects() instead

getAssociatedProjectCategoryObjects

List<ProjectCategory> getAssociatedProjectCategoryObjects()

Deprecated. Project Category contexts are not supported in JIRA and will be removed from the API. Since v6.4.

getAssociatedProjects

@Deprecated
List<org.ofbiz.core.entity.GenericValue> getAssociatedProjects()

Deprecated. since 5.1 use getAssociatedProjectObjects() instead

The associated projects, or an empty list if none associated.

Returns:

a not null list.

getAssociatedProjectObjects

List<Project> getAssociatedProjectObjects()

The associated projects, or an empty list if none associated.

Returns:

a not null list.

See Also:

getAssociatedProjectIds()

getAssociatedProjectIds

@Nonnull
List<Long> getAssociatedProjectIds()

The associated projectIds, or an empty list if none associated. Note that any null project IDs are removed for compatibility with existing behaviour in getAssociatedProjectObjects().

Returns:

a not null list.

See Also:

getAssociatedProjectObjects()

getAssociatedIssueTypes

Set<org.ofbiz.core.entity.GenericValue> getAssociatedIssueTypes()

Deprecated. Use getAssociatedIssueTypeObjects() instead. Since v6.1.

Returns the associated Issue Types.

Returns:

the associated Issue Types.

getAssociatedIssueTypeObjects

Collection<IssueType> getAssociatedIssueTypeObjects()

Returns the associated Issue Types.

Returns:

the associated Issue Types.

getAssociatedIssueTypeIds

@Nonnull
Collection<String> getAssociatedIssueTypeIds()

Returns the associated Issue Types.

Returns:

the associated Issue Types.

isGlobal

boolean isGlobal()

isAllProjects

boolean isAllProjects()

isAllIssueTypes

boolean isAllIssueTypes()

isEnabled

boolean isEnabled()

isBasicMode

boolean isBasicMode()

getConfigsByConfig

org.apache.commons.collections.MultiMap getConfigsByConfig()

Returns a Map whose key is a FieldConfig and values are associated a Collection Issue Type GenericValue

Returns:

MultiMap of configs.

getOneAndOnlyConfig

FieldConfig getOneAndOnlyConfig()

Returns the one and only config for this scheme iff there's only one config associated

Returns:

The associated FieldConfig. Null if no configs, or more than one config

getField

ConfigurableField getField()