org.xbrlapi
Interface AspectValueLabel

All Superinterfaces:

Comparable<XML>, NonFragmentXML, Serializable, XML

All Known Implementing Classes:

AspectValueLabelImpl

public interface AspectValueLabel
extends NonFragmentXML

This interface is related to aspect value label XML resources that have been placed into the data store to cache aspect value labels.

Author:

Geoff Shuetrim (geoff@galexy.net)

Method Summary

URI	getAspectId()
String	getLabel()
URI	getLinkRole()
String	getLocale()
URI	getResourceRole()
URI	getValueId()

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

getLabel

String getLabel()
                throws XBRLException

Returns:

the label for the given aspect value

Throws:

XBRLException

getAspectId

URI getAspectId()
                throws XBRLException

Returns:

the aspect ID

Throws:

XBRLException

getValueId

URI getValueId()
               throws XBRLException

Returns:

the aspect value ID

Throws:

XBRLException

getLocale

String getLocale()
                 throws XBRLException

Returns:

the locale (language) code or null if none is defined.

Throws:

XBRLException

getLinkRole

URI getLinkRole()
                throws XBRLException

Returns:

the extended link role or none if none is defined.

Throws:

XBRLException

getResourceRole

URI getResourceRole()
                    throws XBRLException

Returns:

the resource role or null if none is defined.

Throws:

XBRLException