com.ihr.xbrl.om.errors
Class XBRLAssertionResult

java.lang.Object
  com.ihr.xbrl.om.errors.XBRLAssertionResult

public class XBRLAssertionResult
extends java.lang.Object

Author:

Ignacio

Constructor Summary

XBRLAssertionResult(XBRLFormulaResource assertion, boolean result, XBRLInstance inputInstance, XBRLInstance afterFormulaInstance)
This method can be used to create an XBRLAssertionResult while looking if the XBRLAssertion contains a specific user defined message.

Method Summary

XBRLInstance	getAfterFormulaInstance() Access to the XBRL Report that was created after the evaluation of the variable set Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS is false
java.lang.String	getAssertionID()
XBRLInstance	getInputInstance() Acess to the XBRL Input instance document on this assertion.
java.lang.String	getMessage()
boolean	isNotOk()
boolean	isOK()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XBRLAssertionResult

public XBRLAssertionResult(XBRLFormulaResource assertion,
                           boolean result,
                           XBRLInstance inputInstance,
                           XBRLInstance afterFormulaInstance)
                    throws XFValidationException

This method can be used to create an XBRLAssertionResult while looking if the XBRLAssertion contains a specific user defined message. If the message exist, the assertion message text will be evaluated and the text will be returned when the toString() method of this object is called and when a call to the getMessage() text is invoked. If the message does not exists, then the assertion will be created using a call to the constructor for assertionID and result parameters.

Parameters:

assertion -

result -

Throws:

XFValidationException

Method Detail

getAssertionID

public java.lang.String getAssertionID()

Returns:

the assertionID

isOK

public boolean isOK()

Returns:

the result

isNotOk

public boolean isNotOk()

Returns:

the result

getMessage

public java.lang.String getMessage()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getInputInstance

public XBRLInstance getInputInstance()

Acess to the XBRL Input instance document on this assertion.

Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_INPUT_INTANCE_ON_ASSERTION_RESULTS is false

Returns:

the inputInstance

getAfterFormulaInstance

public XBRLInstance getAfterFormulaInstance()

Access to the XBRL Report that was created after the evaluation of the variable set

Returns null if the DTS Property FORMULA_PROCESSOR_RETAIN_AFTER_FORMULA_INTANCE_ON_ASSERTION_RESULTS is false

Returns:

the afterFormulaInstance