Package Documentation

Object: base-rule-object (The :gendl Package)
Mixins: vanilla-mixin

Description

Encapsulates a basic computation, usually to be displayed to the user. Typically this would be used as a mixin into a more sophisticated rule-object, but the type can be used to detect objects which should be processed as "rules."


Input Slots (optional)

hidden? [from vanilla-mixin*] boolean

Indicates whether the object should effectively be a hidden-object even if specified in :objects. Default is nil.


root [from vanilla-mixin*] gdl instance

The root-level node in this object's ``tree'' (instance hierarchy).


rule-description string

Short description of the rule (generally one line). Defaults to NIL.


rule-description-help string

Verbose description of the purpose of the rule.


rule-result string

The basic return-value, or result, of evaluating the rule.


rule-result-help string

Verbose description of how the rule result is computed.


rule-title string

Title to be used with the rule object. Defaults to NIL.


safe-children [from vanilla-mixin*] list of gdl instances

All objects from the :objects specification, including elements of sequences as flat lists. Any children which throw errors come back as a plist with error information


strings-for-display string

Determines the rule's default name in various internal GDL contexts. Defaults to the rule-title, or "Unnamed Rule" if rule-title is NIL.


suppress-display? boolean

Determines whether the rule is displayed by default in reports etc.


violated? boolean

Indicates whether this rule violates a standard condition.


visible-children [from vanilla-mixin*] list of gdl instances

Additional objects to display in Tatu tree. Typically this would be a subset of hidden-children. Defaults to NIL.


Package Documentation