@PublicApi public interface

FieldConfig

com.atlassian.jira.issue.fields.config.FieldConfig
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

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

Summary

Public Methods
List<FieldConfigItem> getConfigItems()
Returns a list of FieldConfigItems.
CustomField getCustomField()
Returns the related custom field.
String getDescription()
String getFieldId()
Long getId()
String getName()

Public Methods

public List<FieldConfigItem> getConfigItems ()

Returns a list of FieldConfigItems.

Returns

public 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
Throws
DataAccessException if the fieldId does not refer to a valid custom field

public String getDescription ()

public String getFieldId ()

public Long getId ()

public String getName ()