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

All Known Implementing Classes:

FieldConfigSchemeImpl

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.

Method Summary

Set	getAssociatedIssueTypes()
List	getAssociatedProjectCategories()
List	getAssociatedProjects()
Map	getConfigs() Returns a Map whose key is a GenericValue 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	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)
void	setConfigs(Map configs) Sets a Map whose key is a GenericValue of issue types and the value is the FieldConfig for that issue type
void	setContexts(List applicableContexts) Sets the available cotext
void	setDescription(String description)
void	setFieldId(String fieldId)
void	setId(Long id)
void	setName(String name)

Method Detail

getName

String getName()

setName

void setName(String name)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getConfigs

Map getConfigs()

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

Returns:

Map of FieldConfig keyed by GenericValue. Null if nothing associated

setConfigs

void setConfigs(Map configs)

Sets a Map whose key is a GenericValue of issue types and the value is the FieldConfig for that issue type

Parameters:

configs - Map of FieldConfig keyed by GenericValue

getId

Long getId()

setId

void setId(Long id)

getContexts

List getContexts()

Returns a list of JiraContextNode objects this scheme is relevent to

Returns:

list of JiraContextNode. Collections.EMPTY_LIST if no contexts

setContexts

void setContexts(List applicableContexts)

Sets the available cotext

Parameters:

applicableContexts - list of JiraContextNode

isInContext

boolean isInContext(IssueContext issueContext)

getAssociatedProjectCategories

List getAssociatedProjectCategories()

getAssociatedProjects

List getAssociatedProjects()

getAssociatedIssueTypes

Set getAssociatedIssueTypes()

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

setFieldId

void setFieldId(String fieldId)

getField

ConfigurableField getField()