beta.xbrl.xule.Result

A beta.xbrl.xule.Result class represents a XULE assertion or output rule result.

class beta.xbrl.xule.Result

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Attributes

beta.xbrl.xule.Result.effective_rule_name

Returns the effective assertion or output rule name as string. The effective rule name consists of the rule prefix, rule name and rule suffix.

beta.xbrl.xule.Result.expression

Returns a beta.xbrl.xule.Assertion or beta.xbrl.xule.OutputRule object represeting the assertion or output rule expression in the XULE parse tree.

beta.xbrl.xule.Result.message

Returns a beta.xbrl.xule.String object representing the assertion message.

beta.xbrl.xule.Result.rule_focus

Returns either a xbrl.Fact or xbrl.taxonomy.Concept object indicating the main focus of the assertion or output rule.

beta.xbrl.xule.Result.rule_name

Returns the assertion or output rule name as string.

beta.xbrl.xule.Result.rule_name_prefix

Returns the assertion or output rule name prefix as string.

beta.xbrl.xule.Result.rule_name_separator

Returns the assertion or output rule name separator as string.

beta.xbrl.xule.Result.rule_name_suffix

Returns the assertion or output rule name suffix as string.

beta.xbrl.xule.Result.severity

Returns a beta.xbrl.xule.Severity enumeration object repesenting the severity of the assertion.

beta.xbrl.xule.Result.value

Returns a beta.xbrl.xule.Value object represeting the result of an output rule or message of an assertion.

Methods

beta.xbrl.xule.Result.output_attribute(attr)

Returns a beta.xbrl.xule.Value object represeting the output attribute attr.

beta.xbrl.xule.Result.to_error()

Returns a xml.Error object represeting the assertion or output result as an error object.

Special methods

__eq__, __ge__, __gt__, __le__, __lt__, __ne__