com.atlassian.jira.issue.customfields.config.item

Class SettableOptionsConfigItem

java.lang.Object

com.atlassian.jira.issue.customfields.config.item.SettableOptionsConfigItem

All Implemented Interfaces:

FieldConfigItemType

@Internal
public class SettableOptionsConfigItem
extends Object
implements FieldConfigItemType

Constructor Summary

Constructors

Constructor and Description
SettableOptionsConfigItem(CustomFieldType customFieldType, OptionsManager optionsManager)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettableOptionsConfigItem

public SettableOptionsConfigItem(CustomFieldType customFieldType,
                                 OptionsManager optionsManager)

Method Detail

getDisplayName

public String getDisplayName()

Description copied from interface: FieldConfigItemType

The user interface name for this dimension of configuration.

Specified by:

getDisplayName in interface FieldConfigItemType

Returns:

the name.

getDisplayNameKey

public String getDisplayNameKey()

Description copied from interface: FieldConfigItemType

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

Specified by:

getDisplayNameKey in interface FieldConfigItemType

Returns:

the i18n key.

getViewHtml

public String getViewHtml(FieldConfig fieldConfig,
                          FieldLayoutItem fieldLayoutItem)

Description copied from interface: FieldConfigItemType

Renders a view of the current configuration as html.

Specified by:

getViewHtml in interface FieldConfigItemType

Returns:

the view html.

getObjectKey

public String getObjectKey()

Description copied from interface: FieldConfigItemType

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

Specified by:

getObjectKey in interface FieldConfigItemType

Returns:

the configuration key.

getConfigurationObject

public Object getConfigurationObject(Issue issue,
                                     FieldConfig config)

Description copied from interface: FieldConfigItemType

Returns an Object that holds the the configuration.

Specified by:

getConfigurationObject in interface FieldConfigItemType

Returns:

the configuration value.

getBaseEditUrl

public String getBaseEditUrl()

Description copied from interface: FieldConfigItemType

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

Specified by:

getBaseEditUrl in interface FieldConfigItemType

Returns:

the URL.