xbrl.taxonomy.EnumerationItem

An xbrl.taxonomy.EnumerationItem class represents an extensible enumeration XBRL item declaration in the DTS.

Base class: xbrl.taxonomy.Item -> xbrl.taxonomy.Concept

class xbrl.taxonomy.EnumerationItem

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

Attributes

xbrl.taxonomy.Item.balance

Returns the ‘xbrli:balance’ attribute value as an xbrl.taxonomy.Balance enumeration, or None if the ‘xbrli:balance’ attribute is absent.

xbrl.taxonomy.Concept.document

Returns an xbrl.taxonomy.TaxonomySchema object which represents the XBRL taxonomy schema which contains the element declaration for this concept.

xbrl.taxonomy.Concept.documentation_label

Returns an xbrl.taxonomy.Label object which represents the documentation label assigned in the standard 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.EnumerationItem.domain

Returns the value of the ‘enum:domain’ attribute as an xml.QName object, or None if the XSD element declaration item doesn’t have an ‘enum:domain’ attribute.

xbrl.taxonomy.EnumerationItem.domain_head

Returns an xbrl.taxonomy.Item object representing the domain head of the extensible enumeration.

xbrl.taxonomy.EnumerationItem.domain_head_network_node

Returns an xbrl.xdt.DomainMemberNetworkNode object representing the head of the domain member network.

xbrl.taxonomy.EnumerationItem.domain_of_enumeration_values

Returns an iterator of xbrl.taxonomy.Item objects which represent all the usable domain members in the domain of enumeration values.

xbrl.taxonomy.EnumerationItem.head_usable

Returns the value of the ‘enum:headUsable’ attribute as a bool, or False if the XSD element declaration item doesn’t have an ‘enum:headUsable’ attribute.

xbrl.taxonomy.Item.item_type

Returns the concept’s built-in XBRL item base data type as an xbrl.taxonomy.ItemType enumeration.

xbrl.taxonomy.Item.item_type_definition

Returns the concept’s built-in XBRL item base data type as an xsd.TypeDefinition object.

xbrl.taxonomy.Concept.label

Returns an xbrl.taxonomy.Label object which represents the standard label assigned in the standard 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.EnumerationItem.linkrole

Returns the value of the ‘enum:linkrole’ attribute as a string, or None if the XSD element declaration item doesn’t have an ‘enum:linkrole’ attribute.

xbrl.taxonomy.Item.period_type

Returns the ‘xbrli:periodType’ attribute value as an xbrl.taxonomy.PeriodType enumeration.

xbrl.taxonomy.Concept.terse_label

Returns an xbrl.taxonomy.Label object which represents the terse label assigned in the standard 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.Concept.verbose_label

Returns an xbrl.taxonomy.Label object which represents the verbose label assigned in the standard 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.

Methods

xbrl.taxonomy.Concept.custom_attribute_value(qname)

Returns a subclass of xsd.AnySimpleType that corresponds to the schema actual value of the custom attribute with the given QName or None if such attribute does not exist.

xbrl.taxonomy.Concept.has_custom_attribute(qname)

Returns True if the concept’s element declaration has an attribute with the given QName.

xbrl.taxonomy.Item.is_boolean()

Returns True if the concept’s item type is or is derived from xbrli:booleanItemType.

xbrl.taxonomy.Item.is_derived_from(base_type)

Returns True if the concept’s type definition is derived from or equal to the given base type definition. The base type definition can be specified either as an xml.QName or xsd.TypeDefinition object.

xbrl.taxonomy.Item.is_duration()

Returns True if the ‘xbrli:periodType’ attribute value is equal to ‘duration’.

xbrl.taxonomy.Item.is_enum()

Returns True if the concept’s item type is or is derived from enum:enumerationItemType, enum11:enumerationItemType or enum2:enumerationItemType.

xbrl.taxonomy.Item.is_enum_set()

Returns True if the concept’s item type is or is derived from enum11:enumerationsItemType or enum2:enumerationSetItemType.

xbrl.taxonomy.Item.is_fraction()

Returns True if the concept’s item type is or is derived from xbrli:fractionItemType.

xbrl.taxonomy.Item.is_instant()

Returns True if the ‘xbrli:periodType’ attribute value is equal to ‘instant’.

xbrl.taxonomy.Item.is_integer()

Returns True if the concept’s item type is or is derived from a xbrli:integerItemType.

xbrl.taxonomy.Item.is_monetary()

Returns True if the concept’s item type is or is derived from xbrli:monetaryItemType.

xbrl.taxonomy.Item.is_non_numeric()

Returns True if the concept’s item type is or is derived from a non-numeric XBRL item data type.

xbrl.taxonomy.Item.is_numeric()

Returns True if the concept’s item type is or is derived from a numeric XBRL item data type.

xbrl.taxonomy.Item.is_qname()

Returns True if the concept’s item type is or is derived from xbrli:QNameItemType.

xbrl.taxonomy.Item.is_string()

Returns True if the concept’s item type is or is derived from xbrli:stringItemType or xbrli:normalizedStringItemType.

xbrl.taxonomy.Concept.label_relationships(arc_role=None, link_role=None)

Returns an iterator of xbrl.taxonomy.LabelRelationship objects. If called without any arguments, all <labelArc> relationships starting from this concept will be returned. Use arc_role and link_role arguments to constrain the returned relationships.

xbrl.taxonomy.Concept.labels(label_role=None, link_role=None, lang=None, **kargs)

Returns an iterator of xbrl.taxonomy.Label objects. If called without any arguments, all assigned concept-label labels will be returned. Use label_role, arc_role, link_role and lang arguments to constrain the returned labels. If arc_role is not specified, only labels connected by concept-label <labelArc> arcs are considered.

xbrl.taxonomy.Concept.reference_relationships(arc_role=None, link_role=None)

Returns an iterator of xbrl.taxonomy.ReferenceRelationship objects. If called without any arguments, all <referenceArc> relationships starting from this concept will be returned. Use arc_role and link_role arguments to constrain the returned relationships.

xbrl.taxonomy.Concept.references(reference_role=None, link_role=None, **kargs)

Returns an iterator of xbrl.taxonomy.Reference objects. If called without any arguments, all assigned concept-reference references will be returned. Use reference_role, arc_role and link_role arguments to constrain the returned references. If arc_role is not specified, only references connected by concept-reference <referenceArc> arcs are considered.

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

Returns an URI with XPointer fragment that points to this XSD element declaration as a string. If the XSD element declaration 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__