org.xbrlapi
Interface CustomType

All Superinterfaces:

Comparable<XML>, Fragment, Serializable, XML

All Known Subinterfaces:

ArcroleType, RoleType

All Known Implementing Classes:

ArcroleTypeImpl, CustomTypeImpl, RoleTypeImpl

public interface CustomType
extends Fragment

Custom type of XLink arcrole or role

Author:

Geoffrey Shuetrim (geoff@galexy.net)

Method Summary

String	getCustomTypeId() Get the id of the customType.
URI	getCustomURI() Get the custom URI being defined.
String	getDefinition()
List<UsedOn>	getUsedOns()
boolean	isUsedCorrectly(Fragment fragment)
boolean	isUsedOn(URI namespace, String localname) Returns true only if the arcrole can be used on the specified element

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

getCustomTypeId

String getCustomTypeId()
                       throws XBRLException

Get the id of the customType.

Throws:

XBRLException

getCustomURI

URI getCustomURI()
                 throws XBRLException

Get the custom URI being defined.

Throws:

XBRLException

getDefinition

String getDefinition()
                     throws XBRLException

Returns:

the string value of the role definition element or null if none is provided.

Throws:

XBRLException.

XBRLException

isUsedCorrectly

boolean isUsedCorrectly(Fragment fragment)
                        throws XBRLException

Parameters:

fragment - The fragment to be tested to determine if the custom role has been used correctly based on usedOn constraints.

Returns:

true if the custom role has been used correctly on the fragment being checked. Returns false otherwise.

Throws:

XBRLException

isUsedOn

boolean isUsedOn(URI namespace,
                 String localname)
                 throws XBRLException

Returns true only if the arcrole can be used on the specified element

Parameters:

namespace - The namespace of the element being tested for

localname - The local name of the element being tested for

Throws:

XBRLException

getUsedOns

List<UsedOn> getUsedOns()
                        throws XBRLException

Returns:

the list of usedOn child fragments.

Throws:

XBRLException.

XBRLException