Rule review Programmable Macro Language interface

RunReview ( ARRAY )

STRING ARRAY:

Array of dbref names to run the review against.

Runs the review for the given elements. Rules are found from the rule set references of the given elements.

Rules are only reviewed if they are common to all the supplied elements.

Results can be queried using the other methods after this has been run.

Rules ( )

STRING ARRAY

Gets a list of database names of reviewed rules.

Keys ( )

STRING ARRAY

Gets a list of string keys corresponding to reviewed rules.

Results ( )

REAL ARRAY

Gets a list of integer results of reviewed rules:

0 - No result

1 - Pass

2 - Accepted

3 - Warning

4 - Fail

ExpectedValues ( )

STRING ARRAY

Gets a list of expected values corresponding to each of the reviewed rules.

Note:
If the expected value is different for different elements supplied to RunReview, the value is empty.

RuleDescriptions ( )

STRING ARRAY

Gets a list of descriptions for reviewed rules.

ExecutedLogic ( )

STRING ARRAY

Gets a list of logic executed for each reviewed rule.

DesignElements ( )

STRING ARRAY

Gets an array of arrays of strings representing DbElements used to execute each rule.

ValidValues ( )

STRING ARRAY

Gets an array of arrays of strings representing Valid Values for each rule executed.

DataElements ( )

STRING ARRAY

Gets an array of strings representing the data elements associated with the executed rules (if any).

InitRuleReview ( ARRAY )

STRING ARRAY:

Array of dbref names to run the review against.

Runs the review for the given elements. Rules are found from the rule set references of the given elements.

Rules are only reviewed if they are common to all the supplied elements.

The control is populated with the results.

SetDock ( BOOL )

BOOL:

True to enable docking of the control, false to disable.

Run this method to help to ensure the control properly fills the PML container.

RuleReview ( )

NetRuleReview

Gets a NetRuleReview object containing the results from the review in this control. For more information, see Rule review.

Only valid after a review has been run using InitRuleReview.