com.atlassian.jira.issue.fields.config

Interface FieldConfig

All Known Implementing Classes:

FieldConfigImpl

@PublicApi
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.IssueContextImpl(Long, String)  IssueContextImpl(projectId, issueTypeId)};
 FieldConfig fieldConfig = cf.getRelevantConfig(issueContext);
 Options options = optionsManager.getOptions(fieldConfig);
 

See Also:

FieldConfigScheme, FieldConfigItem, ConfigurableField

Method Summary

Modifier and Type	Method and Description
List<FieldConfigItem>	getConfigItems() Returns a list of FieldConfigItems.
<T> ConfigurableField<T>	getConfigurableField() Returns the related configurable field.
CustomField	getCustomField() Deprecated. since v8.15 use the getConfigurableField().
String	getDescription()
String	getFieldId()
Long	getId()
String	getName()

Method Detail

getId

Long getId()

getName

String getName()

getDescription

String getDescription()

getConfigItems

List<FieldConfigItem> getConfigItems()

Returns a list of FieldConfigItems.

Returns:

A list of FieldConfigItems. Collections.emptyList() if nothing

getFieldId

String getFieldId()

getCustomField

@Deprecated
CustomField getCustomField()

Deprecated. since v8.15 use the getConfigurableField().

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

getConfigurableField

@ExperimentalApi
<T> ConfigurableField<T> getConfigurableField()

Returns the related configurable field.

Returns:

Related ConfigurableField

Since:

8.16