@PublicApi public interface

Option

implements SimpleOption<T extends SimpleOption<T>>
com.atlassian.jira.issue.customfields.option.Option
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

should merge with the field.option.Option

Summary

Public Methods
@Nonnull List<Option> getChildOptions()
Return a list of options that exist under this option (i.e.

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

Boolean getDisabled()
Get the disabled status.
GenericValue getGenericValue()
@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).

Option getParentOption()
FieldConfig getRelatedCustomField()
Long getSequence()
String getValue()
The current value of the option.

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

List<Option> retrieveAllChildren(List<Option> listToAddTo)
void setDisabled(Boolean disabled)
void setSequence(Long sequence)
void setValue(String value)
void store()
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.customfields.option.SimpleOption

Public Methods

@Nonnull public 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).

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

public 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.

public GenericValue getGenericValue ()

@Nullable public 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).

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

public Option getParentOption ()

public FieldConfig getRelatedCustomField ()

public Long getSequence ()

public 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).

Returns
  • the value of the option.

public List<Option> retrieveAllChildren (List<Option> listToAddTo)

public void setDisabled (Boolean disabled)

public void setSequence (Long sequence)

public void setValue (String value)

public void store ()