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

All Known Implementing Classes:
FieldConfigImpl

public interface FieldConfig

Represents a particular configuration of aConfigurableField. A configuration can have many facets, such as default value and options. These are customizable through registering FieldConfigItem objects in the getConfigItems() method.

This object is generally used in conjunction as part FieldConfigScheme objects where a config can be attached per IssueType This is used in configuring custom fields..

Sample code

Retrieving a FieldConfig and using it to retrieve a set of custom field options:
 IssueContextImpl issueContext = new IssueContextImpl(projectGV, issueTypeGV);
    FieldConfig fieldConfig = cf.getRelevantConfig(issueContext);
    Options options = optionsManager.getOptions(fieldConfig);
 

See Also:
FieldConfigScheme, FieldConfigItem, ConfigurableField

Method Summary
 java.util.List<FieldConfigItem> getConfigItems()
          Returns a list of FieldConfigItems.
 CustomField getCustomField()
          Returns the related custom field.
 java.lang.String getDescription()
           
 java.lang.String getFieldId()
           
 java.lang.Long getId()
           
 java.lang.String getName()
           
 

Method Detail

getId

java.lang.Long getId()

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

getConfigItems

java.util.List<FieldConfigItem> getConfigItems()
Returns a list of FieldConfigItems.

Returns:
A list of FieldConfigItems. Collections.EMPTY_LIST if nothing

getFieldId

java.lang.String getFieldId()

getCustomField

CustomField getCustomField()
Returns the related custom field. This is very much a legacy method as FieldConfig was originally only used for customfields. Should eventually return a ConfigurableField

Returns:
Related CustomField
Throws:
DataAccessException - if the fieldId does not refer to a valid custom field


Copyright © 2002-2010 Atlassian. All Rights Reserved.