oracle.rules.sdk2.dictionary
Interface Choice

All Superinterfaces:

java.io.Serializable

public interface Choice
extends java.io.Serializable

A Choice provides a hierarchy of choices for a ChoosableProperty.

Nested Class Summary

static class

Choice.Kind enumerate the kinds of choice

Method Summary

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
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	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?

Method Detail

getKind

Choice.Kind getKind()

Get the kind of this choice.

Returns:

Choice.Kind

getName

java.lang.String getName()

Get the name of the choice, typically the last component of the value, relative to the parent

Returns:

name

getName

java.lang.String getName(boolean translate)

Get the name of the choice, typically the last component of the value, relative to the parent

Parameters:

translate - flag to translate the name

Returns:

name

getTranslatedName

@Deprecated
java.lang.String getTranslatedName(RuleDictionary dic)

Deprecated. use #getName(true)

Get the translated name of the choice, typically the last component of the translated value, relative to the parent

Returns:

translated name

getValue

java.lang.String getValue()

Get the value of the choice, suitable for input to SettableProperty.setValue(T)

Returns:

value

getValue

java.lang.String getValue(boolean translate)

Get the value of the choice

Parameters:

translate - flag to translate the value

Returns:

value

getTranslatedValue

@Deprecated
java.lang.String getTranslatedValue(RuleDictionary dic)

Deprecated. use #getValue(true) or Choice.getTranslatedValue()

Get the translated value of the choice

Returns:

translated value

getTranslatedValue

java.lang.String getTranslatedValue()

Get the translated value of the choice, or null if none.

Returns:

translated value, or null

getLiteralValue

java.lang.String getLiteralValue()

Get the literal value associated with this choice, or null if none.

getAltValue

java.lang.String getAltValue()

Get alternate value, e.g. RL name

Returns:

String

getDescription

java.lang.String getDescription()

Get a description of the choice

Returns:

String

getDescription

java.lang.String getDescription(boolean translate)

Get a description of the choice

Parameters:

translate - flag to translate the description

Returns:

String

getType

java.lang.String getType()

Get the data type of the choice

Returns:

alias of data type, or "" if no type

getType

java.lang.String getType(boolean translate)

Get the data type of the choice

Parameters:

translate - flag to translate the data type

Returns:

alias of data type, or "" if no type

getListContentType

java.lang.String getListContentType()

If the type of choice is List, get the data type of the content of the List

Returns:

alias of data type, or "" if no type

getListContentType

java.lang.String getListContentType(boolean translate)

If the type of choice is List, get the data type of the content of the List

Parameters:

translate - flag to translate the data type

Returns:

alias of data type, or "" if no type

isSelectable

boolean isSelectable()

is the Choice selectable? If not, then you must choose a child Choice.

Returns:

flag

isGlobal

boolean isGlobal()

is this choice completely defined by the data model? i.e. a Java static, a global variable, or a function?

isStatic

boolean isStatic()

is the choice a Java static member?

getChildren

java.util.List<Choice> getChildren()

Get children as list. Children are in some sense contained by this Choice. E.g. a fact type may contain properties.

Returns:

list

getParent

Choice getParent()

Get parent choice

Returns:

parent in choice tree

getDefinition

DictionaryComponent getDefinition()

Get the dictionary component that defines this choice. E.g. if the choice's value is "emp.salary", return the salary property of the emp fact type. This method can be used to implement a "goto definition" capability in the UI.

Returns:

DictionaryComponent

getID

DOID getID()

get the Dictionary Object ID (DOID) associated with this Choice

Returns:

DOID or DOID.nil if no DOID exists for this choice.

getTypeID

DOID getTypeID()

get the Dictionary Object ID (DOID) of the type of this Choice

Returns:

DOID or DOID.nil if no type exists for this choice.

getListContentTypeID

DOID getListContentTypeID()

If the type of choice is List, get the Dictionary Object ID (DOID) of the type of the content of the List

Returns:

DOID or DOID.nil if the type of this choice is not List, or the content type of the list is unknown.

isQualified

boolean isQualified()

Is the value of this choice qualified by the value of this choice's parent?

Returns:

isAssignable

boolean isAssignable()

can the choice be used as the target of an assignment?

isAssignablePrefix

boolean isAssignablePrefix()

can some ancestor of the choice be used as the target of an assignment?

isTestable

boolean isTestable()

Can the choice be used in a rule test?