org.xbrlapi

Interface RoleType

All Superinterfaces:

java.lang.Comparable<XML>, CustomType, Fragment, java.io.Serializable, XML

All Known Implementing Classes:

RoleTypeImpl

public interface RoleType
extends CustomType

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ExtendedLink>	getUsingExtendedLinks()
java.util.List<Resource>	getUsingResources()
java.util.List<SimpleLink>	getUsingSimpleLinks()

Methods inherited from interface org.xbrlapi.CustomType

getCustomTypeId, getCustomURI, getDefinition, getUsedOns, isUsedCorrectly, isUsedOn

Methods inherited from interface org.xbrlapi.Fragment

appendElementSchemeXPointer, appendID, getAllChildren, getAllChildrenIndices, getAncestorOrSelf, getChild, getChildren, getChildren, getChildrenIndices, getDataRootElement, getElementSchemeXPointerExpression, getIDXPointerExpression, getLabels, getLabels, getLabels, getLabelsWithLanguage, getLabelsWithLanguageAndResourceRole, getLabelsWithLanguageAndResourceRoleAndLinkRole, getLabelsWithResourceRole, getLanguage, getLanguage, getLanguageName, getLanguageName, getLocalname, getLocalnameFromQName, getNamespace, getNamespaceFromQName, getParent, getParentElement, getParentIndex, getPrefixFromQName, getReferences, getReferencesWithLanguage, getReferencesWithLanguageAndResourceRoleAndLinkRole, getReferencesWithLanguageAndRole, getReferencesWithResourceRole, getReferencingLocators, getSequenceToParentElement, getSequenceToParentElementAsString, getSimpleLinks, getURI, getXPath, getXPointerExpression, isAncestorOf, isChild, isNewFragment, isRoot, setParentIndex, setSequenceToParentElement, setURI

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

getUsingExtendedLinks

java.util.List<ExtendedLink> getUsingExtendedLinks()
                                                   throws XBRLException

Returns:

the list of extended links that use this role as the extended link role.

Throws:

XBRLException

getUsingSimpleLinks

java.util.List<SimpleLink> getUsingSimpleLinks()
                                               throws XBRLException

Returns:

the list of simple links that use this role as the link role.

Throws:

XBRLException

getUsingResources

java.util.List<Resource> getUsingResources()
                                           throws XBRLException

Returns:

the list of XLink resources that use this role as the resource role.

Throws:

XBRLException