xbrl.formula.PeriodRule
¶
An xbrl.formula.PeriodRule
class represents a period rule in a <formula:formula> or <table:table> resource.
Base class: xbrl.formula.AspectRule
Nested classes: xbrl.formula.PeriodRule.Duration
, xbrl.formula.PeriodRule.Forever
, xbrl.formula.PeriodRule.Instant
-
class
xbrl.formula.
PeriodRule
¶ Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a
NotImplementedError
exception.
Attributes¶
-
xbrl.formula.PeriodRule.
duration
¶ Returns an
xbrl.formula.PeriodRule.Duration
object if the period rule has a <formula:duration> child element, otherwise None is returned.
-
xbrl.formula.AspectRule.
element
Returns an
xml.ElementInformationItem
object which represents the XML element information item of the aspect rule.
-
xbrl.formula.PeriodRule.
forever
¶ Returns an
xbrl.formula.PeriodRule.Forever
object if the period rule has a <formula:forever> child element, otherwise None is returned.
-
xbrl.formula.PeriodRule.
instant
¶ Returns an
xbrl.formula.PeriodRule.Instant
object if the period rule has a <formula:instant> child element, otherwise None is returned.
-
xbrl.formula.AspectRule.
source
Returns the inferred value of the ‘source’ attribute as
xml.QName
.
-
xbrl.formula.PeriodRule.
type
¶ Returns the period rule RAV type as an
xbrl.formula.PeriodRuleType
enumaration.
Special methods¶
__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__