org.xbrlapi
Interface Error

All Superinterfaces:

Comparable<XML>, Serializable, XML

All Known Implementing Classes:

ErrorImpl

public interface Error
extends XML

Method Summary

String	getExplanation()
String	getProblemIndex()
URI	getProblemURI()
void	setExplanation(String explanation)
void	setProblemIndex(String index) The index can be null if the problem cannot be sheeted back to a specific fragment.
void	setResourceURI(URI uri)

Methods inherited from interface org.xbrlapi.XML

appendMetadataElement, equals, getBuilder, getDocumentNode, getIndex, getMetaAttribute, getMetadataRootElement, getStore, getType, hashCode, hasMetaAttribute, isa, isa, removeMetaAttribute, removeMetadataElement, serialize, serialize, serialize, serialize, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getProblemIndex

String getProblemIndex()
                       throws XBRLException

Returns:

the index of the problematic fragment.

Throws:

XBRLException - if the URI syntax is incorrect.

setProblemIndex

void setProblemIndex(String index)
                     throws XBRLException

The index can be null if the problem cannot be sheeted back to a specific fragment.

Parameters:

index - The index of the fragment causing the problem.

Throws:

XBRLException

getProblemURI

URI getProblemURI()
                  throws XBRLException

Returns:

the URI of the affected document.

Throws:

XBRLException - if the URI syntax is incorrect.

setResourceURI

void setResourceURI(URI uri)
                    throws XBRLException

Parameters:

uri - the URI of the document causing the problem.

Throws:

XBRLException - if the URI is null

getExplanation

String getExplanation()
                      throws XBRLException

Returns:

the problem explanation.

Throws:

XBRLException

setExplanation

void setExplanation(String explanation)
                    throws XBRLException

Parameters:

explanation - The problem explanation.

Throws:

XBRLException - if the explanation is null