@PublicApi public interface

FieldConfigItemType

com.atlassian.jira.issue.fields.config.FieldConfigItemType
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 single dimension of configuration for a custom field. If a custom field needs to be configured in many ways, each way would have an implementation of this type. Methods defined include those necessary to render the current configured state and a name for the type of configuration that the implementation embodies. Also included are a URL link for directing the browser to the configuration screen and a value for the current configuration as well as a key unique to this configuration type.

Summary

Public Methods
String getBaseEditUrl()
Creates the base of the URL that links to the configuration screen for this type of configuration.
Object getConfigurationObject(Issue issue, FieldConfig config)
Returns an Object that holds the the configuration.
String getDisplayName()
The user interface name for this dimension of configuration.
String getDisplayNameKey()
The i18n key for the user interface name for this dimension of configuration.
String getObjectKey()
Returns a key unique among FieldConfigItemType implementations for the configuration value so it can be retrieved from a key-value pair store.
String getViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
Renders a view of the current configuration as html.

Public Methods

public String getBaseEditUrl ()

Creates the base of the URL that links to the configuration screen for this type of configuration.

Returns
  • the URL.

public Object getConfigurationObject (Issue issue, FieldConfig config)

Returns an Object that holds the the configuration.

Returns
  • the configuration value.

public String getDisplayName ()

The user interface name for this dimension of configuration.

Returns
  • the name.

public String getDisplayNameKey ()

The i18n key for the user interface name for this dimension of configuration.

Returns
  • the i18n key.

public String getObjectKey ()

Returns a key unique among FieldConfigItemType implementations for the configuration value so it can be retrieved from a key-value pair store.

Returns
  • the configuration key.

public String getViewHtml (FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)

Renders a view of the current configuration as html.

Returns
  • the view html.