Package com.atlassian.jira.issue.fields.config

Interface FieldConfigItemType

All Known Implementing Classes:
DefaultValueConfigItem, DefaultValueConfigItem, FuncTestTextAreaCFType.TestFieldConfigItemType, ProjectOptionsConfigItem, SettableOptionsConfigItem, UserFilterConfigItem, VersionOptionsConfigItem, VersionOrderConfigItem
@PublicApi public interface FieldConfigItemType
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.

  • Method Details

    • getDisplayName

      String getDisplayName()
      The user interface name for this dimension of configuration.
      Returns:
      the name.

    • getDisplayNameKey

      String getDisplayNameKey()
      The i18n key for the user interface name for this dimension of configuration.
      Returns:
      the i18n key.

    • getViewHtml

      String getViewHtml(FieldConfig fieldConfig, FieldLayoutItem fieldLayoutItem)
      Renders a view of the current configuration as html.
      Parameters:
      fieldConfig -
      fieldLayoutItem -
      Returns:
      the view html.

    • getObjectKey

      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.

    • getConfigurationObject

      Object getConfigurationObject(Issue issue, FieldConfig config)
      Returns an Object that holds the the configuration.
      Parameters:
      issue -
      config -
      Returns:
      the configuration value.

    • getBaseEditUrl

      String getBaseEditUrl()
      Creates the base of the URL that links to the configuration screen for this type of configuration.
      Returns:
      the URL.