Package oracle.rules.sdk2.dictionary

Interface Choice

All Superinterfaces:
Serializable
All Known Subinterfaces:
VerbalChoice
All Known Implementing Classes:
AbstractChoiceImpl, AbstractPermutedChoice, AbstractVerbalChoice, ActionPermutedChoice, ChoiceImpl, SimpleTestPermutedChoice, VerbalChoiceImpl
public interface Choice extends Serializable
A Choice provides a hierarchy of choices for a ChoosableProperty.

  • Method Details

    • getKind

      Choice.Kind getKind()
      Get the kind of this choice.
      Returns:
      Choice.Kind

    • getName

      String getName()
      Get the name of the choice, typically the last component of the value, relative to the parent
      Returns:
      name

    • getName

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

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

    • getValue

      String getValue(boolean translate)
      Get the value of the choice
      Parameters:
      translate - flag to translate the value
      Returns:
      value

    • getTranslatedValue

      @Deprecated String getTranslatedValue(RuleDictionary dic)
      Deprecated.
      use {@link #getValue(true)} or getTranslatedValue()
      Get the translated value of the choice
      Returns:
      translated value

    • getTranslatedValue

      String getTranslatedValue()
      Get the translated value of the choice, or null if none.
      Returns:
      translated value, or null

    • getLiteralValue

      String getLiteralValue()
      Get the literal value associated with this choice, or null if none.

    • getAltValue

      String getAltValue()
      Get alternate value, e.g. RL name
      Returns:
      String

    • getDescription

      String getDescription()
      Get a description of the choice
      Returns:
      String

    • getDescription

      String getDescription(boolean translate)
      Get a description of the choice
      Parameters:
      translate - flag to translate the description
      Returns:
      String

    • getType

      String getType()
      Get the data type of the choice
      Returns:
      alias of data type, or "" if no type

    • getType

      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

      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

      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

      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?

    • isExpanded

      boolean isExpanded()
      Should the choice be expanded to display first order children?

    • getVerbalValue

      String getVerbalValue()
      Get the 'Verbal' value of the choice. This value is only used for constructing verbal choices in a Verbal Rule.
      Returns:
      'Verbal' value of this Choice if any, "" Otherwise

    • getVerbalValue

      String getVerbalValue(boolean translate)
      Get the (optionally translated) 'Verbal' value of the choice
      Parameters:
      translate - flag to optionally translate the value
      Returns:
      'Verbal' value of this Choice if any, "" Otherwise