com.ihr.xbrl.om.assertions

Interface EvaluableAssertion

All Known Implementing Classes:

XBRLAssertion, XBRLConsistencyAssertion, XBRLExistenceAssertion, XBRLValueAssertion

public interface EvaluableAssertion

The Interface EvaluableAssertion.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
XBRLAssertionResult[]	evaluateAssertion(XBRLInstance doc, XBRLEvaluationContext evalContext) Required for evaluating the assertion.
java.lang.String	getErrorIdentification() Returns an string that identifies the assertion when an error is produced.
java.lang.String	getLabel() This is implemented by the surrounding resource.
XBRLResource	getResource() Returns the XBRLResource that contains the definition of the assertion.

Method Detail

evaluateAssertion

XBRLAssertionResult[] evaluateAssertion(XBRLInstance doc,
                                        XBRLEvaluationContext evalContext)
                                 throws XFValidationException

Required for evaluating the assertion.

Parameters:

doc - the doc

evalContext - This is the thread evaluation context

Returns:

the XBRL assertion result[]

Throws:

XFValidationException - the XF validation exception

getLabel

java.lang.String getLabel()

This is implemented by the surrounding resource.

Returns:

the label

getErrorIdentification

java.lang.String getErrorIdentification()

Returns an string that identifies the assertion when an error is produced.

Returns:

the error identification

getResource

XBRLResource getResource()

Returns the XBRLResource that contains the definition of the assertion.

Returns:

the XBRL Resource