com.batavia.xbrl.taxonomy.type
Interface ArcroleType

All Superinterfaces:

java.lang.Comparable, ComparablePart, ExtensionType, IdHolder, IdKeeper, java.io.Serializable, TaxonomyElement, org.relaxng.datatype.ValidationContext, XbrlElement, XmlElement, XmlParticle

public interface ArcroleType
extends ExtensionType, IdHolder

The arcroleType element is the element containing the definition of custom arc role types.

The arcroleType element describes the custom arc role type by declaring the arc role value, declaring the elements that the arc role type may be used on, declaring the type of cycles that are allowed for a network of arcs using the arc role type, and providing a human-readable definition of the meaning of the arc role type.

Arc role values occur on [XLINK] arcs as the value of the xlink:arcrole attribute. Arc role values MUST be either a standard arc role value defined by this specification or be a custom arc role type. Custom arc role types MUST be defined using the arcroleType element. The arcroleType element MUST be located at the [XPATH] path “schema/annotation/appinfo”. The arc role values defined by this specification MUST NOT be redefined using the arcroleType element.

There MUST NOT be more than one arcroleType element with the same arcroleURI attribute value within a taxonomy schema. Within a DTS, there MAY be more than one arcroleType element with the same arcroleURI attribute value. However, all arcroleType elements with the same arcroleURI attribute value MUST be s-equal.

The value of the xlink:arcrole attribute MUST be a URI. For the definitionArc, calculationArc, presentationArc, labelArc, referenceArc and footnoteArc the value of the xlink:arcrole attribute MUST be either a standard arc role value defined by this specification or a custom arc role value. The value of the arcroleURI identifies the xlink:arcrole attribute value that is being defined. The values of the usedOn sub-elements identify which arcs may use this arc role type. Because arcroleType elements are pointed to via an arcroleRef element in linkbases that use the custom arc role value, the arcroleType element MAY have an id attribute.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:

Ron van Ardenne

Method Summary

void	addDefinition(Definition definition) Add the Definition child for this ArcroleType.
void	addUsedOn(UsedOn aPart) Add the UsedOn to the collection of usedon elements for this ArcroleType
XmlAttribute	getArcroleUri()
XmlAttribute	getCyclesAllowed()
Definition	getDefinition() Get the Definition for this ArcroleType.
XmlAttribute	getId()
java.util.List	getUsedOnElements() Get the collection of usedon elements for this ArcroleType
void	removeUsedOn(UsedOn aPart) Remove the UsedOn from the collection of usedon elements for this ArcroleType
void	setArcroleUri(XmlAttribute arcroleUri)
void	setCyclesAllowed(XmlAttribute cyclesAllowed)
void	setId(XmlAttribute id)

Methods inherited from interface com.batavia.xbrl.taxonomy.TaxonomyElement

getRoot, hasDecendantsWithAttribute, hasUnknownDecendants

Methods inherited from interface com.batavia.xbrl.XbrlElement

addChild, fromXbrl, getMyDiscoverableTaxonomySet, getXbrlElementNameSpace, removeChild, toXbrlStream, toXbrlString

Methods inherited from interface com.batavia.xml.XmlElement

addAttribute, addChild, addChildren, addComment, addMessage, addNameSpace, clearMessages, fromXml, getAttribute, getAttribute, getAttributeSet, getChild, getChildren, getChildren, getDefaultNameSpace, getDocumentHref, getErrorMessage, getFullyQualifiedNameValue, getMappedChildren, getMessages, getName, getNameSpace, getNameSpacePrefixes, getNameSpaces, getPointedElement, getValidXmlBase, getValue, getXmlElementNameSpace, getXmlRoot, isValid, moveChild, removeAttribute, removeChild, resolvePointedValue, resolvePointedXmlParticle, setAttributeValue, setChildren, setDocumentHref, setErrorMessage, setInit, setName, setTargetNameSpace, setValue, toXml, toXml, toXmlStream, toXmlString, toXstringBuffer, validate

Methods inherited from interface com.batavia.xml.XmlParticle

destroy, getBaseUri, getParent, getPrefix, getTargetNameSpace, isBoolean, isNumber, p_equal, resolveNamespacePrefix, setParent, toXstring

Methods inherited from interface com.batavia.xml.ComparablePart

c_equal, identical, s_equal, u_equal, v_equal, x_equal

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.relaxng.datatype.ValidationContext

isNotation, isUnparsedEntity

Methods inherited from interface com.batavia.xml.IdKeeper

addIdHolder, getHolder, removeIdHolder

Method Detail

getDefinition

Definition getDefinition()

Get the Definition for this ArcroleType.

Returns:

Definition

addDefinition

void addDefinition(Definition definition)

Add the Definition child for this ArcroleType.

getUsedOnElements

java.util.List getUsedOnElements()

Get the collection of usedon elements for this ArcroleType

Returns:

List

addUsedOn

void addUsedOn(UsedOn aPart)

Add the UsedOn to the collection of usedon elements for this ArcroleType

Parameters:

aPart -

removeUsedOn

void removeUsedOn(UsedOn aPart)

Remove the UsedOn from the collection of usedon elements for this ArcroleType

Parameters:

aPart -

getArcroleUri

XmlAttribute getArcroleUri()

Returns:

Returns the arcroleUri.

setArcroleUri

void setArcroleUri(XmlAttribute arcroleUri)

Parameters:

arcroleUri - The arcroleUri to set.

getCyclesAllowed

XmlAttribute getCyclesAllowed()

Returns:

Returns the cyclesAllowed.

setCyclesAllowed

void setCyclesAllowed(XmlAttribute cyclesAllowed)

Parameters:

cyclesAllowed - The cyclesAllowed to set.

getId

XmlAttribute getId()

Specified by:

getId in interface IdHolder

Returns:

Returns the id.

setId

void setId(XmlAttribute id)

Parameters:

id - The id to set.