com.atlassian.jira.issue.customfields.manager

Interface OptionsManager

All Known Implementing Classes:

CachedOptionsManager, DefaultOptionsManager, MockOptionsManager

@PublicApi
public interface OptionsManager

Manages option values for fields (eg. custom field select lists).

Method Summary

Modifier and Type	Method and Description
Option	createOption(FieldConfig fieldConfig, Long parentOptionId, Long sequence, String value)
List<Option>	createOptions(FieldConfig config, Long parentOptionId, Long sequence, Iterable<String> options) Bulk version of createOption(FieldConfig, Long, Long, String) method
void	deleteOptionAndChildren(Option option)
void	disableOption(Option option) Set an option to disabled.
void	enableOption(Option option) Set an option to enabled.
Option	findByOptionId(Long optionId)
List<Option>	findByOptionValue(String value) Finds all options with the given value.
List<Option>	findByParentId(Long parentOptionId)
List<Option>	getAllOptions() Retreives all Option in the system.
Options	getOptions(FieldConfig fieldConfig) Get options for this particular custom field type.
void	removeCustomFieldConfigOptions(FieldConfig fieldConfig)
void	removeCustomFieldOptions(CustomField customField)
void	setRootOptions(FieldConfig fieldConfig, Options options)
void	setValue(Option option, String value)
void	updateOptions(Collection<Option> options) Update a set of options.

Method Detail

getOptions

Options getOptions(FieldConfig fieldConfig)

Get options for this particular custom field type. As a custom field may have multiple types of options (eg cascading drop downs), the type can be used to signify this

Parameters:

fieldConfig - For example, retrieved from CustomField.getRelevantConfig(com.atlassian.jira.issue.Issue)

Returns:

An option Object of Options

setRootOptions

void setRootOptions(FieldConfig fieldConfig,
                    Options options)

removeCustomFieldOptions

void removeCustomFieldOptions(CustomField customField)

removeCustomFieldConfigOptions

void removeCustomFieldConfigOptions(FieldConfig fieldConfig)

updateOptions

void updateOptions(Collection<Option> options)

Update a set of options. After doing this, any existing Options objects may be stale, and should be re-fetched with getOptions(com.atlassian.jira.issue.fields.config.FieldConfig).

Parameters:

options - Usually an Options implementation.

createOption

Option createOption(FieldConfig fieldConfig,
                    Long parentOptionId,
                    Long sequence,
                    String value)

createOptions

@ExperimentalApi
List<Option> createOptions(FieldConfig config,
                                            Long parentOptionId,
                                            Long sequence,
                                            Iterable<String> options)

Bulk version of createOption(FieldConfig, Long, Long, String) method

deleteOptionAndChildren

void deleteOptionAndChildren(Option option)

findByOptionId

Option findByOptionId(Long optionId)

getAllOptions

List<Option> getAllOptions()

Retreives all Option in the system.

Returns:

a list of all options in the system

enableOption

void enableOption(Option option)

Set an option to enabled.

Parameters:

option - The Option to enable.

disableOption

void disableOption(Option option)

Set an option to disabled. A disabled option will is not available to be assigned to this associated custom field, It remains valid historically and for searching with.

Parameters:

option - The option to be disabled.

setValue

void setValue(Option option,
              String value)

findByOptionValue

List<Option> findByOptionValue(String value)

Finds all options with the given value. Returns and empty list if no options are found.

Parameters:

value - the value of the options to find (case insensitive). Must not be null.

Returns:

the list of found options, empty if non found.

findByParentId

List<Option> findByParentId(Long parentOptionId)