com.atlassian.jira.issue.customfields.option

Interface Option

All Superinterfaces:

SimpleOption<Option>

All Known Implementing Classes:

LazyLoadedOption, MockOption

@PublicApi
public interface Option
extends SimpleOption<Option>

should merge with the field.option.Option

Method Summary

Modifier and Type	Method and Description
List<Option>	getChildOptions() Return a list of options that exist under this option (i.e.
Boolean	getDisabled() Get the disabled status.
org.ofbiz.core.entity.GenericValue	getGenericValue()
Long	getOptionId() The ID of the option or null if it currently does not have one.
Option	getParentOption()
FieldConfig	getRelatedCustomField()
Long	getSequence()
String	getValue() The current value of the option.
List<Option>	retrieveAllChildren(List<Option> listToAddTo)
void	setDisabled(Boolean disabled)
void	setSequence(Long sequence)
void	setValue(String value)
void	store()

Method Detail

getSequence

Long getSequence()

getDisabled

Boolean getDisabled()

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

getGenericValue

org.ofbiz.core.entity.GenericValue getGenericValue()

getRelatedCustomField

FieldConfig getRelatedCustomField()

getParentOption

Option getParentOption()

setSequence

void setSequence(Long sequence)

setValue

void setValue(String value)

setDisabled

void setDisabled(Boolean disabled)

retrieveAllChildren

List<Option> retrieveAllChildren(@Nullable
                                 List<Option> listToAddTo)

store

void store()

getOptionId

@Nullable
Long getOptionId()

The ID of the option or null if it currently does not have one.

NOTE: This method is here is keep the API checker happy (see JRADEV-23901).

Specified by:

getOptionId in interface SimpleOption<Option>

Returns:

the ID of the option or null if it does not have one.

getValue

String getValue()

The current value of the option. This is the option displayed to the user.

NOTE: This method is here is keep the API checker happy (JRADEV-23901).

Specified by:

getValue in interface SimpleOption<Option>

Returns:

the value of the option.

getChildOptions

@Nonnull
List<Option> getChildOptions()

Return a list of options that exist under this option (i.e. its children).

NOTE: This method is here is keep the API checker happy (JRADEV-23901).

Specified by:

getChildOptions in interface SimpleOption<Option>

Returns:

the list of options that exist under this option. An empty list is returned when such options exist.