org.xbrlapi
Interface Stub

All Superinterfaces:

Comparable<XML>, NonFragmentXML, Serializable, XML

All Known Implementing Classes:

StubImpl

public interface Stub
extends NonFragmentXML

Method Summary

String	getReason()
URI	getResourceURI()
void	setReason(String reason)
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, setBuilder, setIndex, setMetaAttribute, setResource, setStore, updateInStore

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getReason

String getReason()
                 throws XBRLException

Returns:

the reason that the stub was stored.

Throws:

XBRLException

getResourceURI

URI getResourceURI()
                   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 described by the stub.

Throws:

XBRLException - if the URI is null

setReason

void setReason(String reason)
               throws XBRLException

Parameters:

reason - The reason for the stub to exist.

Throws:

XBRLException - if the reason is null