xbrl.formula.VariableSetAssertion

An xbrl.formula.VariableSetAssertion class represents a <validation:variableSetAsertion> resource in the formula linkbase.

Base class: xbrl.formula.VariableSet -> xbrl.taxonomy.Resource

class xbrl.formula.VariableSetAssertion

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

Attributes

xbrl.formula.VariableSet.aspect_model

Returns the value of the ‘aspectModel’ attribute as an xbrl.formula.AspectModel enumeration.

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.formula.VariableSet.filter_relationships

Returns an iterator of xbrl.formula.VariableSetFilterRelationship objects which represent the variable-set-filter relationships from this <variable:variableSet> resource.

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.formula.VariableSet.implicit_filtering

Returns the inferred value of the ‘implicitFiltering’ attribute as bool.

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.VariableSet.precondition_relationships

Returns an iterator of xbrl.formula.VariableSetPreconditionRelationship objects which represent the variable-set-precondition relationships from this <variable:variableSet> resource.

xbrl.taxonomy.Resource.qname

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

xbrl.formula.VariableSetAssertion.satisfied_message_relationships

Returns an iterator of xbrl.formula.AssertionSatisfiedMessageRelationship objects which represent the assertion-satisfied-message relationships from this <validation:assertion> resource.

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.formula.VariableSetAssertion.unsatisfied_message_relationships

Returns an iterator of xbrl.formula.AssertionUnsatisfiedMessageRelationship objects which represent the assertion-unsatisfied-message relationships from this <validation:assertion> resource.

xbrl.formula.VariableSetAssertion.unsatisfied_severity

Returns either the associated or default severity level as an xbrl.formula.SeverityLevel enumeration.

xbrl.formula.VariableSetAssertion.unsatisfied_severity_relationships

Returns an iterator of xbrl.formula.AssertionUnsatisfiedSeverityRelationship objects which represent the assertion-unsatisfied-severity relationships from this <validation:assertion> resource.

xbrl.formula.VariableSet.variable_set_relationships

Returns an iterator of xbrl.formula.VariableSetRelationship objects which represent the variable-set relationships from this <variable:variableSet> resource.

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.formula.VariableSetAssertion.evaluate(Instance instance, **kargs)

Processes this assertion against the given XBRL instance and returns an xbrl.formula.AssertionProcessingResult, xml.ErrorLog tuple. Formula parameters can be set using the ‘formula_parameters’ argument by supplying a dict with the user-supplied parameter values. Use the same JSON format as accepted by the –formula-parameters CLI option. Other assertion processing options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valxbrl.htm for a list of available options. Any errors and warnings reported during the assertion processing can be accessed through the returned xml.ErrorLog object.

xbrl.formula.VariableSet.find_variable(qname)

[Deprecated: Use resolve_variable() instead!] Returns an xbrl.formula.Parameter or xbrl.formula.Variable object which represents the formula paramter or variable with the given XML qualified name within the scope of this variable set, or None if no parameter or variable was found.

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.VariableSet.referenced_parameters()

Returns an iterator of xbrl.formula.Parameter objects representing the referenced formula parameters by this <variable:variableSet> resource and any other associated resources.

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.formula.VariableSet.resolve_variable(qname)

Returns an xbrl.formula.Parameter or xbrl.formula.Variable object which represents the formula paramter or variable with the given XML qualified name within the scope of this variable set, or None if no parameter or variable was found.

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__