FieldConfigScheme (Atlassian Jira

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

Nested Classes
Modifier and Type Interface and Description

static class FieldConfigScheme.Builder

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FieldConfigScheme.Builder`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`Collection<String>`	`getAssociatedIssueTypeIds()` Returns the ids for the associated Issue Types.
`default Collection<IssueType>`	`getAssociatedIssueTypeObjects()` Deprecated. Since v7.0
`Collection<IssueType>`	`getAssociatedIssueTypes()` Returns the associated Issue Types.
`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.
`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 relevant to
`String`	`getDescription()`
`ConfigurableField<?>`	`getField()`
`Long`	`getId()`
`String`	`getName()`
`FieldConfig`	`getOneAndOnlyConfig()` Returns the one and only config for this scheme if 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 relevant to
    
    Returns:
    
    list of JiraContextNode. an empty list if no contexts
  - isInContext
```
boolean isInContext(IssueContext issueContext)
```
  - 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
```
Collection<IssueType> getAssociatedIssueTypes()
```
    Returns the associated Issue Types.
    
    Returns:
    
    the associated Issue Types.
  - getAssociatedIssueTypeObjects
```
@Deprecated
default Collection<IssueType> getAssociatedIssueTypeObjects()
```
    Deprecated. Since v7.0
    
    Returns the associated Issue Types.
    
    Returns:
    
    the associated Issue Types.
  - getAssociatedIssueTypeIds
```
@Nonnull
Collection<String> getAssociatedIssueTypeIds()
```
    Returns the ids for the associated Issue Types.
    
    Returns:
    
    ids for 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
```
@Nullable
FieldConfig getOneAndOnlyConfig()
```
    Returns the one and only config for this scheme if there's only one config associated.
    
    Returns:
    
    The associated FieldConfig. Null if no configs, or more than one config
  - getField
```
ConfigurableField<?> getField()
```

Interface FieldConfigScheme

Nested Class Summary

Method Summary

Method Detail

getName

getDescription

getConfigs

getId

getContexts

isInContext

getAssociatedProjectObjects

getAssociatedProjectIds

getAssociatedIssueTypes

getAssociatedIssueTypeObjects

getAssociatedIssueTypeIds

isGlobal

isAllProjects

isAllIssueTypes

isEnabled

isBasicMode

getConfigsByConfig

getOneAndOnlyConfig

getField