org.xbrlapi

Interface AspectValueLabel

All Superinterfaces:

java.lang.Comparable<XML>, NonFragmentXML, java.io.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

Methods

Modifier and Type	Method and Description
java.lang.String	getAspectId()
java.lang.String	getLabel()
java.lang.String	getLinkRole()
java.lang.String	getLocale()
java.lang.String	getResourceRole()
java.lang.String	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

java.lang.String getLabel()
                          throws XBRLException

Returns:

the label for the given aspect value

Throws:

XBRLException

getAspectId

java.lang.String getAspectId()
                             throws XBRLException

Returns:

the aspect ID

Throws:

XBRLException

getValueId

java.lang.String getValueId()
                            throws XBRLException

Returns:

the aspect value ID

Throws:

XBRLException

getLocale

java.lang.String getLocale()
                           throws XBRLException

Returns:

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

Throws:

XBRLException

getLinkRole

java.lang.String getLinkRole()
                             throws XBRLException

Returns:

the extended link role or none if none is defined.

Throws:

XBRLException

getResourceRole

java.lang.String getResourceRole()
                                 throws XBRLException

Returns:

the resource role or null if none is defined.

Throws:

XBRLException