xbrl.table.RuleSet

An xbrl.table.RuleSet represents a rule set of a <table:ruleNode> resource in the table linkbase.

class xbrl.table.RuleSet

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

Attributes

xbrl.table.RuleSet.aspect_rules

Returns an iterator of xbrl.formula.AspectRule objects which represents the aspect rules in the rule set.

xbrl.table.RuleSet.concept_rule

Returns an xbrl.formula.ConceptRule object which represents the concept rule in the rule set, or None if the rule set doesn’t contain a concept rule.

xbrl.table.RuleSet.element

Returns an xml.ElementInformationItem object which represents <table:ruleSet> element information item or the <table:ruleNode> element information item in case of an untagged rule set.

xbrl.table.RuleSet.entity_identifier_rule

Returns an xbrl.formula.EntityIdentifierRule object which represents entity identifier rule in the rule set, or None if the rule set doesn’t contain an entity identifier rule.

xbrl.table.RuleSet.period_rule

Returns an xbrl.formula.PeriodRule object which represents the period rule in the rule set, or None if the rule set doesn’t contain a period rule.

xbrl.table.RuleSet.tag

Returns the value of the ‘tag’ attribute as string or None if this rule set object represents the untagged rule set.

xbrl.table.RuleSet.unit_rule

Returns an xbrl.formula.UnitRule object which represents the unit rule in the rule set, or None if the rule set doesn’t contain an unit rule.

Methods

xbrl.table.RuleSet.dimension_rule(Dimension dimension)

Returns an xbrl.formula.DimensionRule object which represents the dimension rule for the given dimension aspect in the rule set. Returns None if the rule set doesn’t contain such a dimension rule.

xbrl.table.RuleSet.occ_aspect_rule(occtype)

[Deprecated: use occ_rule() instead!] Returns an xbrl.formula.OCCRule objects which represents the OCC rule in the rule set. Use occtype to retrieve either the segment or scenario OCC rule. Returns None if the rule set doesn’t contain such a OCC rule.

xbrl.table.RuleSet.occ_rule(occtype)

Returns an xbrl.formula.OCCRule objects which represents the OCC rule in the rule set. Use occtype to retrieve either the segment or scenario OCC rule. Returns None if the rule set doesn’t contain such a OCC rule.

Special methods

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__