org.xbrlapi
Interface UsedOn

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Implementing Classes:

UsedOnImpl

public interface UsedOn
extends Fragment

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getUsedOnLocalname()
URI	getUsedOnNamespace()
boolean	isUsedOn(URI namespaceURI, String localname) Returns true only if the custom role type can be used on the specified element based on this usedOn fragment.

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

getUsedOnNamespace

URI getUsedOnNamespace()
                       throws XBRLException

Returns:

the namespace URI of the element that can be used on.

Throws:

XBRLException

getUsedOnLocalname

String getUsedOnLocalname()
                          throws XBRLException

Returns:

the local name of the element that the custom XLINK link role, resource role, or arc role can be used on.

Throws:

XBRLException

isUsedOn

boolean isUsedOn(URI namespaceURI,
                 String localname)
                 throws XBRLException

Returns true only if the custom role type can be used on the specified element based on this usedOn fragment.

Parameters:

namespaceURI - The namespace of the element being tested for

localname - The local name of the element being tested for

Throws:

XBRLException