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