Interface Option
- All Superinterfaces:
SimpleOption<Option>
- All Known Implementing Classes:
LazyLoadedOption
,MockOption
Should merge with the field.option.Option
Option
since 2005.-
Method Summary
Modifier and TypeMethodDescriptionReturn a list of options that exist under this option (i.e.Get the disabled status.org.ofbiz.core.entity.GenericValue
The ID of the option or null if it currently does not have one.Get related CustomField's FieldConfig.getValue()
The current value of the option.retrieveAllChildren
(List<Option> listToAddTo) Deprecated.void
setDisabled
(Boolean disabled) void
setSequence
(Long sequence) void
void
store()
-
Method Details
-
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()Get related CustomField's FieldConfig.- Returns:
- FieldConfig of a CustomField
-
getParentOption
Option getParentOption() -
getParentOptionId
-
setSequence
-
setValue
-
setDisabled
-
retrieveAllChildren
Deprecated.UsegetChildOptions()
instead. Since v9.17- Parameters:
listToAddTo
- the list to add the options to- Returns:
- a list of all descendant options
-
store
void store() -
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 interfaceSimpleOption<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 interfaceSimpleOption<Option>
- Returns:
- the value of the 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 interfaceSimpleOption<Option>
- Returns:
- the list of options that exist under this option. An empty list is returned when such options exist.
-
getChildOptions()
instead.