com.ihr.xbrl.gui.interfaces

Interface HasErrorsHandler

public interface HasErrorsHandler

The Interface HasErrorsHandler.

Author:

Ignacio

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SELECTED_ERROR_CHANGED_EVENT Global event fired when the user has selected a row representing an error.
static java.lang.String	VALIDATIONRESULTSET Property to register for changes in the validation report so listeners can do getValidationReport() and see if a new report was set or the previous one is now deleted (null).

Method Summary

Modifier and Type	Method and Description
XBRLAssertionResult	getUserSelectedAssertionResult() Classes implementing this interface might return the user selected XBRLAssertionResult to allow GUI to change the cell background of cells with facts used during the assertion evaluation.
XBRLInconsistency	getUserSelectedInconsistency() Classes implementing this interface might return the user selected XBRLInconsistency to allow GUI to change the cell background of cells with facts used during the core validation.
XBRLFact	getUserSelectedSearchFact() Gets the user selected search fact.
XBRLValidationReport	getValidationReport() Access to the validation report that is now represented. or null if none is set
void	setExtraErrorsReport(XBRLValidationReport valReport) Sets additional errors that will be added to the validation report.
void	showErrors(XBRLValidationReport valReport) The most common implementation just opens a DlgValidationErrors dialog and pass the validation report.
XBRLValidationReport	validateDTS(XBRLInstance instance) Executes validation of the instance document that is being edited and generates a new XBRLValidation report.

Field Detail

VALIDATIONRESULTSET

static final java.lang.String VALIDATIONRESULTSET

Property to register for changes in the validation report so listeners can do getValidationReport() and see if a new report was set or the previous one is now deleted (null).

See Also:

Constant Field Values

SELECTED_ERROR_CHANGED_EVENT

static final java.lang.String SELECTED_ERROR_CHANGED_EVENT

Global event fired when the user has selected a row representing an error.

See Also:

Constant Field Values

Method Detail

showErrors

void showErrors(XBRLValidationReport valReport)

The most common implementation just opens a DlgValidationErrors dialog and pass the validation report. A call to this method produces a VALIDATIONRESULTSET property change event and the report can be obtained from the newValue in the event

Parameters:

valReport - the val report

getValidationReport

XBRLValidationReport getValidationReport()

Access to the validation report that is now represented. or null if none is set

Returns:

current XBRLValidationReport represented

setExtraErrorsReport

void setExtraErrorsReport(XBRLValidationReport valReport)

Sets additional errors that will be added to the validation report.

Parameters:

valReport - the XBRLValidationReport with extra errors

validateDTS

XBRLValidationReport validateDTS(XBRLInstance instance)

Executes validation of the instance document that is being edited and generates a new XBRLValidation report. The processor can optimize processors created in order to speed-up execution

Parameters:

instance - the XBRL instance report to validate

Returns:

a new XBRLValidationRepot with validation summary

getUserSelectedAssertionResult

XBRLAssertionResult getUserSelectedAssertionResult()

Classes implementing this interface might return the user selected XBRLAssertionResult to allow GUI to change the cell background of cells with facts used during the assertion evaluation. The method might return null if no XBRLAssertionResult is selected by the user. In order to report changes in the user selected value, it is encouraged that applications register a listener on the global event SELECTED_ERROR_CHANGED_EVENT declared on this interface

Returns:

the user selected assertion result

getUserSelectedInconsistency

XBRLInconsistency getUserSelectedInconsistency()

Classes implementing this interface might return the user selected XBRLInconsistency to allow GUI to change the cell background of cells with facts used during the core validation. The method might return null if no XBRLInconsistency is selected by the user. In order to report changes in the user selected value, it is encouraged that applications register a listener on the global event SELECTED_ERROR_CHANGED_EVENT declared on this interface

Returns:

the user selected inconsistency

getUserSelectedSearchFact

XBRLFact getUserSelectedSearchFact()

Gets the user selected search fact.

Returns:

the user selected search fact