xbrl.formula.Parameter

An xbrl.formula.Parameter class represents a <variable:parameter> resource in the formula linkbase.

Base class: xbrl.taxonomy.Resource

class xbrl.formula.Parameter

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

Attributes

xbrl.formula.Parameter.as_type

Returns an xml.QName object which represents the XML qualified name of the XSD type declaration, or None if the ‘as’ attribute is absent.

xbrl.taxonomy.Resource.document

Returns an xml.Document object which represents the XBRL taxonomy document which contains this resource.

xbrl.taxonomy.Resource.documentation_label

Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the documentation generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.effective_role

Returns the value of the ‘xlink:role’ attribute as a string, or the standard role for this resource if the XML element information item doesn’t have an ‘xlink:role’ attribute. If no default standard role has been defined for this resource None is returned.

xbrl.taxonomy.Resource.element

Returns an xml.ElementInformationItem object which represents the XML element information item of the <xl:resource> resource.

xbrl.taxonomy.Resource.extended_link

Returns an xbrl.taxonomy.ExtendedLink object which represents the containin XLink extended link.

xbrl.taxonomy.Resource.id

Returns the value of the ‘id’ attribute as a string, or None if the XML element information item doesn’t have an ‘id’ attribute.

xbrl.taxonomy.Resource.label

Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the standard generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.formula.Parameter.name

Returns an xml.QName object which represents the XML qualified name of the formula parameter.

xbrl.taxonomy.Resource.qname

Returns an xml.QName object which represents the XML qualified name of the resource element information item.

xbrl.formula.Parameter.required

Returns True if the value of the ‘required’ attribute was set to ‘true’.

xbrl.formula.Parameter.select

Returns an xbrl.XPathExpression object representing the XPath expression in the ‘select’ attribute, or None if the ‘select’ attribute is absent.

xbrl.taxonomy.Resource.terse_label

Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the terse generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.verbose_label

Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the verbose generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.xlink_label

Returns the value of the ‘xlink:label’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:label’ attribute.

xbrl.taxonomy.Resource.xlink_role

Returns the value of the ‘xlink:role’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:role’ attribute.

xbrl.taxonomy.Resource.xlink_title

Returns the value of the ‘xlink:title’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:title’ attribute.

Methods

xbrl.taxonomy.Resource.label_relationships(link_role=None)

Returns an iterator of xbrl.taxonomy.ElementLabelRelationship objects. If called without any arguments, all element-label <gen:arc> relationships starting from this resource will be returned. Use the link_role argument to constrain the returned relationships.

xbrl.taxonomy.Resource.labels(label_role=None, link_role=None, lang=None)

Returns an iterator of xbrl.taxonomy.Label objects. If called without any arguments, all assigned generic labels will be returned. Use label_role, link_role and lang arguments to constrain the returned labels.

xbrl.taxonomy.Resource.reference_relationships(link_role=None)

Returns an iterator of xbrl.taxonomy.ElementReferenceRelationship objects. If called without any arguments, all element-reference <gen:arc> relationships starting from this resource will be returned. Use the link_role argument to constrain the returned relationships.

xbrl.formula.Parameter.referenced_parameters()

Returns an iterator of xbrl.formula.Parameter objects representing the referenced formula parameters in the ‘select’ XPath expression.

xbrl.taxonomy.Resource.references(reference_role=None, link_role=None)

Returns an iterator of xbrl.taxonomy.Reference objects. If called without any arguments, all assigned generic references will be returned. Use reference_role and link_role arguments to constrain the returned references.

xbrl.taxonomy.Resource.xpointer(bForceElementScheme=False)

Returns an URI with XPointer fragment that points to this XML element as a string. If the XML element information item has an id attribute, a shorthand pointer with the id attribute value will be generated, otherwise the XPointer element scheme will be used. Set force_element_scheme to True to prevent generation of shorthand pointers.

Special methods

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