public interface Choice
extends java.io.Serializable
ChoosableProperty
.Modifier and Type | Interface and Description |
---|---|
static class |
Choice.Kind
enumerate the kinds of choice
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAltValue()
Get alternate value, e.g.
|
java.util.List<Choice> |
getChildren()
Get children as list.
|
DictionaryComponent |
getDefinition()
Get the dictionary component that defines this choice.
|
java.lang.String |
getDescription()
Get a description of the choice
|
java.lang.String |
getDescription(boolean translate)
Get a description of the choice
|
DOID |
getID()
get the Dictionary Object ID (DOID) associated with this Choice
|
Choice.Kind |
getKind()
Get the kind of this choice.
|
java.lang.String |
getListContentType()
If the type of choice is List,
get the data type of the content of the List
|
java.lang.String |
getListContentType(boolean translate)
If the type of choice is List,
get the data type of the content of the List
|
DOID |
getListContentTypeID()
If the type of choice is List,
get the Dictionary Object ID (DOID) of the type of the content of the List
|
java.lang.String |
getLiteralValue()
Get the literal value associated with this choice, or null if none.
|
java.lang.String |
getName()
Get the name of the choice, typically the last component of the value, relative to the parent
|
java.lang.String |
getName(boolean translate)
Get the name of the choice, typically the last component of the value, relative to the parent
|
Choice |
getParent()
Get parent choice
|
java.lang.String |
getTranslatedName(RuleDictionary dic)
Deprecated.
use #getName(true)
|
java.lang.String |
getTranslatedValue()
Get the translated value of the choice, or null if none.
|
java.lang.String |
getTranslatedValue(RuleDictionary dic)
Deprecated.
use
#getValue(true) or Choice.getTranslatedValue() |
java.lang.String |
getType()
Get the data type of the choice
|
java.lang.String |
getType(boolean translate)
Get the data type of the choice
|
DOID |
getTypeID()
get the Dictionary Object ID (DOID) of the type of this Choice
|
java.lang.String |
getValue()
Get the value of the choice, suitable for input to
SettableProperty.setValue(T) |
java.lang.String |
getValue(boolean translate)
Get the value of the choice
|
java.lang.String |
getVerbalValue()
Get the 'Verbal' value of the choice.
|
java.lang.String |
getVerbalValue(boolean translate)
Get the (optionally translated) 'Verbal' value of the choice
|
boolean |
isAssignable()
can the choice be used as the target of an assignment?
|
boolean |
isAssignablePrefix()
can some ancestor of the choice be used as the target of an assignment?
|
boolean |
isExpanded()
Should the choice be expanded to display first order children?
|
boolean |
isGlobal()
is this choice completely defined by the data model?
|
boolean |
isQualified()
Is the value of this choice qualified by the value of this choice's parent?
|
boolean |
isSelectable()
is the Choice selectable?
|
boolean |
isStatic()
is the choice a Java static member?
|
boolean |
isTestable()
Can the choice be used in a rule test?
|
Choice.Kind getKind()
Choice.Kind
java.lang.String getName()
java.lang.String getName(boolean translate)
translate
- flag to translate the name@Deprecated java.lang.String getTranslatedName(RuleDictionary dic)
java.lang.String getValue()
SettableProperty.setValue(T)
java.lang.String getValue(boolean translate)
translate
- flag to translate the value@Deprecated java.lang.String getTranslatedValue(RuleDictionary dic)
#getValue(true)
or Choice.getTranslatedValue()
java.lang.String getTranslatedValue()
java.lang.String getLiteralValue()
java.lang.String getAltValue()
java.lang.String getDescription()
java.lang.String getDescription(boolean translate)
translate
- flag to translate the descriptionjava.lang.String getType()
java.lang.String getType(boolean translate)
translate
- flag to translate the data typejava.lang.String getListContentType()
java.lang.String getListContentType(boolean translate)
translate
- flag to translate the data typeboolean isSelectable()
boolean isGlobal()
boolean isStatic()
java.util.List<Choice> getChildren()
Choice getParent()
DictionaryComponent getDefinition()
DOID getID()
DOID getTypeID()
DOID getListContentTypeID()
boolean isQualified()
boolean isAssignable()
boolean isAssignablePrefix()
boolean isTestable()
boolean isExpanded()
java.lang.String getVerbalValue()
java.lang.String getVerbalValue(boolean translate)
translate
- flag to optionally translate the value