@PublicApi public interface

ConfigurableField

implements OrderableField<V>
com.atlassian.jira.issue.fields.ConfigurableField<V>
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

ConfigurableField are fields which have FieldConfigItemType that can be stored for a given JiraContextNode

Summary

[Expand]
Inherited Constants
From interface com.atlassian.jira.issue.fields.OrderableField
Public Methods
List<Project> getAssociatedProjectObjects()
Returns a list of projects associated with this field.
List<FieldConfigItemType> getConfigurationItemTypes()
Returns a List of FieldConfigItemType objects.
FieldConfig getRelevantConfig(IssueContext issueContext)
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.fields.Field
From interface com.atlassian.jira.issue.fields.OrderableField
From interface com.atlassian.jira.issue.fields.SearchableField
From interface java.lang.Comparable

Public Methods

public List<Project> getAssociatedProjectObjects ()

Returns a list of projects associated with this field. Will be null if the field is global

Returns
  • a list of projects associated with this field.

public List<FieldConfigItemType> getConfigurationItemTypes ()

Returns a List of FieldConfigItemType objects. This opens up possibilties for configurable custom fields

Returns

public FieldConfig getRelevantConfig (IssueContext issueContext)