com.batavia.xbrl.taxonomy.xlink
Interface RoleRef

All Superinterfaces:
java.lang.Comparable, ComparablePart, IdKeeper, java.io.Serializable, SimpleLink, TaxonomyElement, org.relaxng.datatype.ValidationContext, XbrlElement, Xlink, XmlBaseHolder, XmlElement, XmlParticle

public interface RoleRef
extends SimpleLink

One or more roleRef elements (defined in Section 3.5.2.4) MAY be used in XBRL instances.

If used, they MUST appear immediately after the linkbaseRef elements in the XBRL instance, in document order. roleRef elements are used in XBRL instances to reference the definitions of any custom xlink:role attribute values used in footnote links in the XBRL instance.

The roleRef element is used to resolve non-standard xlink:role values that are used in the linkbase. The roleRef element is a simple link, as defined in Section 3.5.1. The roleRef element points to the roleType element in a taxonomy schema document that declares the xlink:role attribute value. For each non-standard xlink:role attribute value used in the linkbase there MUST be a roleRef element.

During DTS discovery, the taxonomy schema that is pointed to by the roleRef element is discovered.

Copyright 2006 J2R BV, The Netherlands.

Part of Licensed Materials.

www.batavia-xbrl.com

Author:
Ron van Ardenne

Method Summary
 XmlAttribute getRoleURI()
          Get the roleuri attribute
 void setRoleURI(XmlAttribute roleURI)
          Set the roluri attribute
 
Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.SimpleLink
getAbsoluteXlinkHref, getXlinkArcrole, getXlinkHref, getXlinkRole, getXmlBase, setXlinkArcrole, setXlinkHref, setXlinkRole, setXmlBase, validate
 
Methods inherited from interface com.batavia.xbrl.taxonomy.xlink.Xlink
getLinkbaseContainer, getXlinkType, setXlinkType
 
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
 
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

getRoleURI

XmlAttribute getRoleURI()
Get the roleuri attribute

Returns:
XmlAttribute

setRoleURI

void setRoleURI(XmlAttribute roleURI)
Set the roluri attribute

Parameters:
roleURI -