xfi:fact-has-explicit-dimension

  1. The XBRL Standard
  2. XBRL Specifications
  3. Registries
  4. Functions Registry 1.0
  5. Functions Registry
  6. xfi:fact-has-explicit-dimension

xs:boolean=xfi:fact-has-explicit-dimension( $item as schema-element(xbrli:item), $dimension as xs:QName)

Last updated on 02-09-2008 at 00:00:00.

Tests whether the fact reports a value for a dimension in either the segment or scenario of the supplied item.

OIM Status

Deprecated - this function may be used in OIM-compatible Formula Rules, but its use is not recommended.

Parameters

Name Type Details
item schema-element(xbrli:item) The item that the dimension is to be reported for.
dimension xs:QName The QName of the dimension being tested for.

Output

Type: xs:boolean

Returns true if the fact reports a value for the given dimension in either segment, scenario, or as a default dimension member.

This function does not raise an exception if the dimension or member does not apply to the fact, but instead returns false if so.

The dimension default is deemed applicable when the dimension is not reported for the item, regardless of the dimensional validity of this default value for the item (e.g., the default is reported even when the primary item concept, of an item lacking the dimension, is in a closed hypercube that does not allow the dimension or does not allow the default member).

Errors

Code Details
xfie:invalidExplicitDimensionQName This error MUST be thrown the dimension QName is not a explicit dimension in the reference discoverable taxonomy set. This error is only raised if the QName is not that of a dimension. If the dimension is valid and inapplicable to the fact, then the fact does not have that dimension, and false is returned.

Conformance suite

90306 xfi.fact-has-explicit-dimension testcase.xml [ download ]

Owners

Name Affiliation Email Start End
Herm Fischer UBMatrix / Mark V Systems fischer@markv.com 01-09-2008 at 00:00:00

Revisions

Name On Details
Herm Fischer 01-09-2008 at 00:00:00 Created the function definition.
Herm Fischer 02-09-2008 at 00:00:00 Renamed has-explicit-dimension and separated has-typed-dimension to be a separate function. Renumbered subsequent directories. Reverted error code invalidExplicitDimensionQName to have explicit in its name.
Herm Fischer 18-03-2011 at 16:00:00 Clarified that dimension default values are reported for a dimension without respect to such a default value's validity for a given primary item.