com.batavia.xbrl.taxonomy.type
Interface RoleType

All Superinterfaces:

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

public interface RoleType
extends ExtensionType, IdHolder

The roleType element contains a custom role type definition.

The roleType element describes the custom role type by defining the roleURI of the role type, declaring the elements that the role type may be used on, and providing a human-readable definition of the role type.

Role types define allowed values for the xlink:role attribute on the [XLINK] simple link, extended link and resource elements. Extended link role values MUST be equal to either the standard extended link role value (defined in Section 3.5.3.3) or they must be equal to a custom role type that is defined in a taxonomy schema using the roleType element. The roleType element MUST be located at the [XPATH] path “schema/annotation/appinfo”. The role types that are defined by this specification MUST NOT be redefined using the roleType element.

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

The value of the xlink:role attribute MUST be an absolute URI. For the definitionLink, calculationLink, presentationLink, labelLink, referenceLink, footnoteLink, label, reference, and footnote elements, the value of the xlink:role attribute MUST be a custom role type defined by this specification or be a standard role value defined in this specification.

The value of the roleURI attribute identifies the xlink:role attribute value that is being defined. The values of the usedOn sub-elements identify which elements are allowed to use the custom role type. Since roleType elements are pointed to via a roleRef element in linkbases that use the custom role type, the roleType 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	addUsedOn(UsedOn aPart) Add the UsedOn to the collection of UsedOn elements for this RoleType
Definition	getDefinition() Get the definition for this roletype.
XmlAttribute	getId()
XmlAttribute	getRoleUri()
java.util.List	getUsedOnElements() get the collection of UsedOn elements for this RoleType
void	removeUsedOn(UsedOn aPart) Remove the UsedOn from the collection of UsedOn elements for this RoleType
void	setDefinition(Definition definition) Set the definition for this roletype.
void	setId(XmlAttribute id)
void	setRoleUri(XmlAttribute roleUri)

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 roletype.

Returns:

Definition

setDefinition

void setDefinition(Definition definition)

Set the definition for this roletype.

Parameters:

Definition -

getUsedOnElements

java.util.List getUsedOnElements()

get the collection of UsedOn elements for this RoleType

Returns:

List

addUsedOn

void addUsedOn(UsedOn aPart)

Add the UsedOn to the collection of UsedOn elements for this RoleType

Parameters:

aPart -

removeUsedOn

void removeUsedOn(UsedOn aPart)

Remove the UsedOn from the collection of UsedOn elements for this RoleType

Parameters:

aPart -

getId

XmlAttribute getId()

Specified by:

getId in interface IdHolder

Returns:

Returns the id.

setId

void setId(XmlAttribute id)

Parameters:

id - The id to set.

getRoleUri

XmlAttribute getRoleUri()

Returns:

Returns the roleUri.

setRoleUri

void setRoleUri(XmlAttribute roleUri)

Parameters:

roleUri - The roleUri to set.