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.


Nested Class Summary
static class FieldConfigScheme.Builder
           
 
Method Summary
 java.util.Set<org.ofbiz.core.entity.GenericValue> getAssociatedIssueTypes()
           
 java.util.List<org.ofbiz.core.entity.GenericValue> getAssociatedProjectCategories()
           
 java.util.List<org.ofbiz.core.entity.GenericValue> getAssociatedProjects()
          The associated projects, or an empty list if none associated.
 java.util.Map<java.lang.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
 java.util.List<JiraContextNode> getContexts()
          Returns a list of JiraContextNode objects this scheme is relevent to
 java.lang.String getDescription()
           
 ConfigurableField getField()
           
 java.lang.Long getId()
           
 java.lang.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

java.lang.String getName()

getDescription

java.lang.String getDescription()

getConfigs

java.util.Map<java.lang.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

java.lang.Long getId()

getContexts

java.util.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

java.util.List<org.ofbiz.core.entity.GenericValue> getAssociatedProjectCategories()

getAssociatedProjects

java.util.List<org.ofbiz.core.entity.GenericValue> getAssociatedProjects()
The associated projects, or an empty list if none associated.

Returns:
a not null list.

getAssociatedIssueTypes

java.util.Set<org.ofbiz.core.entity.GenericValue> 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

getField

ConfigurableField getField()


Copyright © 2002-2010 Atlassian. All Rights Reserved.