xff:uncovered-aspect

xs:anyType?=xff:uncovered-aspect( $aspect as xs:token, $dimension as xs:QName?)

Last updated on 19-11-2009 at 22:00:00.

Returns the specified uncovered aspect for use in XPath expressions of a consistency assertion, value assertion, formula aspect rule, or generic message XPath expression. The function is not applicable to variable-set variable evaluation and filter expressions.

XBRL 2.1 Section 4.7.3

OIM Status

Supported

Parameters

Name	Type	Details
aspect	xs:token	The aspect value MUST be one of: concept entity-identifier location period unit complete-segment complete-scenario non-XDT-segment non-XDT-scenario dimension See output, below, for the value of the function for each aspect.
dimension	xs:QName?	For a dimension aspect, this parameter MUST be provided and is the QName of the dimension. For other aspects, this parameter may be omitted, or may be supplied as an empty sequence.

Output

Type: xs:anyType?

Returns the uncovered aspect requested, or an empty sequence if not applicable. The following paragraphs provide the output type for each aspect (where present).

If the aspect value is 'concept' then the output MUST be of type xs:QName and is the uncovered concept aspect value.

If the aspect value is 'entity-identifier' then the output MUST be of type element(xbrli:identifier) and is the uncovered entity identifier element aspect value.

If the aspect value is 'location' then the output MUST be of type element() and is the uncovered location aspect value. This element() MUST be a fact item or tuple that is a descendant of the xbrli:xbrl instance element.

If the aspect value is 'period' then the output MUST be of type element(xbrli:period) and is the uncovered period element aspect value. If there is no such aspect then an empty sequence is output.

If the aspect value is 'unit' then the output MUST be of type element(xbrli:unit)? and is the uncovered unit element aspect value. If there is no such aspect then an empty sequence is output.

If the aspect value is 'complete-segment' then the output MUST be of type element(xbrli:segment)? and is the uncovered complete-segment element aspect value, in which the elements and their descendant nodes have the appropriate type based on the Post Schema Validation Infoset. If there is no such aspect then an empty sequence is output.

If the aspect value is 'complete-scenario' then the output MUST be of type element(xbrli:scenario)? and is the uncovered complete-scenario element aspect value, in which the elements and their descendant nodes have the appropriate type based on the Post Schema Validation Infoset. If there is no such aspect then an empty sequence is output.

If the aspect value is 'non-XDT-segment' then the output MUST be of type element()* and is the uncovered non-XDT-segment element nodes, in which those non-XDT segment element nodes and their descendant nodes have the appropriate type based on the Post Schema Validation Infoset. Note that complete-segment returns the segment node and non-XDT-segment returns a collection of non-XDT child nodes of the segment. If there is no such aspect then an empty sequence is output.

If the aspect value is 'non-XDT-scenario' then the output MUST be of type element()* and is the uncovered non-XDT-scenario element nodes, in which those non-XDT scenario element nodes and their descendant nodes have the appropriate type based on the Post Schema Validation Infoset. Note that complete-scenario returns the scenario node and non-XDT-scenario returns a collection of non-XDT child nodes of the scenario. If there is no such aspect then an empty sequence is output.

If the aspect value is 'dimension', and the dimension is an explicit dimension, then the output MUST be of type xs:QName and is the member of the uncovered explicit dimension aspect value.

If the aspect value is 'dimension', and the dimension is a typed dimension, then the output MUST be of type element(xbrldi:typedMember)? and is the child element of the segment or scenario that contains the typed dimension value if there is a value for the dimension in either the segment or scenario bound to the uncovered aspect and returns the empty sequence otherwise. The data type of the child and its descendant elements have the appropriate type based on the Post Schema Validation Infoset.

If the aspect value is 'dimension' and either there are no dimensional aspects, or the dimension QName input is an empty sequence, or it does not represent a dimension aspect that is uncovered, then an empty sequence is output.

Errors

Code	Details
xffe:invalidFunctionUse	This error MUST be thrown if the this function is referenced in an XPath expression invoked in variable-set variable evaluation, such as by a generalVariable or filter XPath expression. A formula processor MAY detect this error as a static compilation-time error if it this function is referenced in variable-set evaluation expressions (by generalVariable or filters). A formula processor MUST detect this error as a dynamic run-time error if it this function is referenced in variable-set evaluation expressions (by generalVariable or filters), such as during execution of an XPath or other language implementation of custom functions that were invoked dynamically in variable-set evaluation expressions (by generalVariable or filters). This error MUST be thrown if the this function is referenced in an XPath expression invoked in an XPath function related to an existence assertion, including if referenced in an XPath expression from generic messages relating to an existence assertion. This error MUST be thrown if implicit filtering is 'false'.

Code

Details

xffe:invalidFunctionUse

This error MUST be thrown if the this function is referenced in an XPath expression invoked in variable-set variable evaluation, such as by a generalVariable or filter XPath expression. A formula processor MAY detect this error as a static compilation-time error if it this function is referenced in variable-set evaluation expressions (by generalVariable or filters). A formula processor MUST detect this error as a dynamic run-time error if it this function is referenced in variable-set evaluation expressions (by generalVariable or filters), such as during execution of an XPath or other language implementation of custom functions that were invoked dynamically in variable-set evaluation expressions (by generalVariable or filters). This error MUST be thrown if the this function is referenced in an XPath expression invoked in an XPath function related to an existence assertion, including if referenced in an XPath expression from generic messages relating to an existence assertion. This error MUST be thrown if implicit filtering is 'false'.

Conformance suite

80155 xff.uncovered-aspect function testcase.xml [ download ]

Owners

Name	Affiliation	Email	Start	End
Herm Fischer	UBMatrix / Mark V Systems	fischer@markv.com	19-11-2009 at 22:00:00
Richard Ashby	CoreFiling Ltd	rna@corefiling.com	08-09-2011 at 00:00:00

Revisions

Name	On	Details
Herm Fischer	19-11-2009 at 22:00:00	Defined the function
Herm Fischer	13-12-2009 at 22:00:00	Changed prefix to xff, namespace to function/formula from function/instance, per wiki & WG discussions.
Herm Fischer	07-09-2010 at 00:00:00	Incorporated feedback from Hitoshi Okumura. Added error conditions when function is referenced in relation to an existence assertion, and implicit filtering 'false'.
Herm Fischer	27-10-2010 at 00:00:00	Incorporated feedback from Hitoshi Okumura. Modified entity-identifier aspect to return the xbrli:identifier element, for consistency with variables spec description of this aspect.
Herm Fischer	08-07-2011 at 00:00:00	Incorporated feedback from Victor Morilla by improving summary statement wording.
Richard Ashby	08-09-2011 at 00:00:00	Erratum addition to documentation. Function returns empty sequence for period aspect value when evaluation binds to tuple, which has no period.