Package com.atlassian.jira.issue.customfields.manager

Class DefaultOptionsManager

java.lang.Object

com.atlassian.jira.issue.customfields.manager.DefaultOptionsManager

All Implemented Interfaces:

OptionsManager

Direct Known Subclasses:

CachedOptionsManager

public class DefaultOptionsManager
extends Object
implements OptionsManager

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITY_CONFIG_ID
protected final FieldConfigManager	fieldConfigManager
protected static final List<String>	ORDER_BY_LIST

Constructor Summary

Constructors

Constructor	Description
DefaultOptionsManager(OfBizDelegator delegator, FieldConfigManager fieldConfigManager)

Method Summary

Modifier and Type	Method	Description
Option	createOption(FieldConfig fieldConfig, Long parentOptionId, Long sequence, String value)	Create a new option for the given custom field config.
List<Option>	createOptions(FieldConfig config, Long parentOptionId, Long sequence, Iterable<String> options)	Bulk version of OptionsManager.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)	Finds all options with the given parent option id.
List<Option>	getAllOptions()	Retreives all Option in the system.
Options	getOptions(FieldConfig fieldConfig)	Get options for this particular custom field type.
List<Option>	getOptions(CustomField field, Collection<Long> projectIds, Collection<String> issueTypeIds)	Returns all options in the context of given projects and issue types for the custom field.
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.

Methods inherited from class java.lang.Object

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

Field Details

ENTITY_CONFIG_ID

public static final String ENTITY_CONFIG_ID

See Also:

• Constant Field Values

ORDER_BY_LIST

protected static final List<String> ORDER_BY_LIST

fieldConfigManager

protected final FieldConfigManager fieldConfigManager

Constructor Details

DefaultOptionsManager

public DefaultOptionsManager(OfBizDelegator delegator,
 FieldConfigManager fieldConfigManager)

Method Details

getOptions

public Options getOptions(FieldConfig fieldConfig)

Description copied from interface: OptionsManager

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

Specified by:

getOptions in interface OptionsManager

Parameters:

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

Returns:

An option Object of Options

setRootOptions

public void setRootOptions(FieldConfig fieldConfig,
 Options options)

Specified by:

setRootOptions in interface OptionsManager

removeCustomFieldOptions

public void removeCustomFieldOptions(CustomField customField)

Specified by:

removeCustomFieldOptions in interface OptionsManager

removeCustomFieldConfigOptions

public void removeCustomFieldConfigOptions(FieldConfig fieldConfig)

Specified by:

removeCustomFieldConfigOptions in interface OptionsManager

updateOptions

public void updateOptions(Collection<Option> options)

Description copied from interface: OptionsManager

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

Specified by:

updateOptions in interface OptionsManager

Parameters:

options - Usually an Options implementation.

createOption

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

Description copied from interface: OptionsManager

Create a new option for the given custom field config.

Specified by:

createOption in interface OptionsManager

Parameters:

fieldConfig - The custom field config to create the option for

parentOptionId - The id of the parent option, or null if this is a root option

sequence - The sequence of the option (position on the list)

value - The value of the option

Returns:

The newly created option

createOptions

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

Description copied from interface: OptionsManager

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

Specified by:

createOptions in interface OptionsManager

deleteOptionAndChildren

public void deleteOptionAndChildren(Option option)

Specified by:

deleteOptionAndChildren in interface OptionsManager

getAllOptions

public List<Option> getAllOptions()

Description copied from interface: OptionsManager

Retreives all Option in the system.

Specified by:

getAllOptions in interface OptionsManager

Returns:

a list of all options in the system

disableOption

public void disableOption(Option option)

Description copied from interface: OptionsManager

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.

Specified by:

disableOption in interface OptionsManager

Parameters:

option - The option to be disabled.

enableOption

public void enableOption(Option option)

Description copied from interface: OptionsManager

Set an option to enabled.

Specified by:

enableOption in interface OptionsManager

Parameters:

option - The Option to enable.

setValue

public void setValue(Option option,
 String value)

Specified by:

setValue in interface OptionsManager

findByOptionValue

public List<Option> findByOptionValue(String value)

Description copied from interface: OptionsManager

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

Specified by:

findByOptionValue in interface OptionsManager

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.

findByOptionId

public Option findByOptionId(Long optionId)

Specified by:

findByOptionId in interface OptionsManager

findByParentId

public List<Option> findByParentId(Long parentOptionId)

Description copied from interface: OptionsManager

Finds all options with the given parent option id. Returns an empty list if no options are found.

Specified by:

findByParentId in interface OptionsManager

Parameters:

parentOptionId - the id of the parent option.

Returns:

the list of found options, empty if non found.

getOptions

@Nonnull
public List<Option> getOptions(@Nonnull
 CustomField field,
 @Nonnull
 Collection<Long> projectIds,
 @Nonnull
 Collection<String> issueTypeIds)

Description copied from interface: OptionsManager

Returns all options in the context of given projects and issue types for the custom field.

Specified by:

getOptions in interface OptionsManager

Parameters:

field - a custom field whose options are requested

projectIds - a collection of project ids

issueTypeIds - a collection of issue types ids

Returns:

a list of options for the given custom field and context or an empty list if no options exist.

See Also:

• SearchContext
• CustomField.getReleventConfig(SearchContext)
• FieldConfig