## Uses of Class
com.ihr.xbrl.om.taxonomy.XBRLArcroleType

- Packages that use XBRLArcroleType
  Package | Description
  --- | ---
  com.ihr.xbrl.adins.efm.errors | Provides classes for the specific error messages for the the implementation of the Edgar Filer Manual validation add-in This package is part of the implementation of the Edgar Filer Manual
  com.ihr.xbrl.dts | Provides the classes necessary to investigate the content of a DTS.
  com.ihr.xbrl.om | Provides the classes necessary to start processing XBRL information.
  com.ihr.xbrl.om.errors | Provides the classes necessary to produce and process XBRL related errors There are two error categories.
  com.ihr.xbrl.om.exLinks | Provides the classes necessary to process, read and write XBRL Linkbases and XBRL Extended links.
  com.ihr.xbrl.om.formula | Provides the classes necessary to implement a plug in XBRL processor for validation of docuents and taxonomies according to the XBRL formula specification 1.0 At this stage the package is just created.
  com.ihr.xbrl.om.formula.functions.reusable | Contains classes than can be reused from XFI functions and other classes in the API that requires the same functionality but without the overhead of being an XFI function with parameters
  com.ihr.xbrl.om.table | This package contains an object model to work with tables as defined in the XBRL Table specification The current implementation is based on table linkbase PWD http://www.xbrl.org/Specification/table-linkbase/PWD-2013-05-17/table-linkbase-PWD-2013-05-17.html The XBRLTableProcessor class
  com.ihr.xbrl.om.taxonomy | Provides the classes necessary to process, write and read XBRL Taxonomy schemas and content of the XBRL Taxonomy Schemas that requires XBRL processing.
  com.ihr.xbrl.om.xdt | Provides the classes necessary to implement a plug in XBRL processor for validation of dimensional instance documents according to the XBRL Dimensions specification 1.0 This package contains two hierarchies of classes.
  com.ihr.xbrl.pojo | Provides the classes necessary to access to the content of a DTS using POJO technology.
  com.rs.xbrl |

- - ### Uses of XBRLArcroleType in com.ihr.xbrl.adins.efm.errors

    Constructors in com.ihr.xbrl.adins.efm.errors with parameters of type XBRLArcroleType
    Constructor and Description
    `EFMInvalidEmptyDefinitionOfArcroleType(XBRLArcroleType xbrlArcroleType)` Instantiates a new EFM invalid empty definition of arcrole type.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.dts

    Methods in com.ihr.xbrl.dts that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLTreeWalker.`getArcrole()` Gets the arcrole.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om

    Methods in com.ihr.xbrl.om that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | DTSContainer.`getStaticArcroleTypeByURI(java.lang.String arcrole)` Gets the static arcrole type by uri.

    Methods in com.ihr.xbrl.om that return types with arguments of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Vector<XBRLArcroleType>` | DTSContainer.`getArcroleType(java.lang.String uri)` Access to the arcroleType object from the URI regardless where it is defined or if there are multiple valid definitions of the same arcrole URI.
    `java.util.Iterator<XBRLArcroleType>` | DTSContainer.`getArcroleTypes()` Access to an iterator over defined XBRL Arcrole Types defined on all taxonomies in the loaded DTS.

    Methods in com.ihr.xbrl.om with parameters of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `void` | DTSContainer.`addArcroleType(XBRLArcroleType arcrole)` Register a new arcroleType declaration.
    `void` | DTSContainer.`delArcroleType(XBRLArcroleType arcrole)` Unregister a loaded arcroleType declaration.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole)` Obtains an iterator over all relationships where this fragment is the source of the relationship and the arcrole corresponds to the parameter indicated.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base)` Returns the relationship objects that contains this element in the source of the relationship using a filter on the arcrole value.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the source of the relationship using a filter on the arcrole value and that belongs to a specific base.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole)` Obtains an iterator over all relationships where this fragment is the target of the relationship and the arcrole corresponds to the parameter indicated.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value regardless the base set the relationship belongs to.
    `java.util.Iterator<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, DTSBase base)` Returns the relationship objects that contains this element in the target of the relationship or null if there is none.
    `java.util.Collection<XBRLRelationship>` | XMLFragment.`getToRelationships(XBRLArcroleType arcrole, DTSBase base, java.util.Comparator<XBRLRelationship> comparator)` Returns a collection of relationship objects that contains this element in the target of the relationship using a filter on the arcrole value and that belongs to a specific base.
    `void` | XBRLCoreProcessor.`validateCyclesOnBaseSet(DTSBase base, XBRLArcroleType arcRole, int cyclesAllowed)` This is the internal method used by the API to validate cycles on a base set.

    Method parameters in com.ihr.xbrl.om with type arguments of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLCoreProcessor.`setArcrolesToCheckCycles(java.util.Collection<? extends XBRLArcroleType> xbrlArcroleTypes)` Sets the arcroles to check cycles.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.errors

    Constructors in com.ihr.xbrl.om.errors with parameters of type XBRLArcroleType
    Constructor and Description
    `XBRLValidationExceptionMultipleArcroleTypeDefinitions(XBRLArcroleType art1, XBRLArcroleType art2)` Instantiates a new XBRL validation exception multiple arcrole type definitions.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.exLinks

    Methods in com.ihr.xbrl.om.exLinks that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLRelationship.`getArcroleType()` Access to the [Arcrole] property.
    `XBRLArcroleType` | XBRLArcroleRef.`getArcroleType()` Gets the arcrole type.
    `XBRLArcroleType` | XBRLExtendedLink.`getArcroleType(java.lang.String arcrole)` Returns the arcroleType of an arc on this extended link resolved using the corresponding arcroleRef element or the static definition in the specifications.

    Methods in com.ihr.xbrl.om.exLinks that return types with arguments of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLArcroleType>` | XBRLExtendedLink.`getArcroles()` Access to all used arcroles.
    `java.util.Iterator<XBRLArcroleType>` | DTSBase.`getArcroles(XBRLExtendedLink filter)` An iterator over arcroles in one extended link.
    `java.util.Iterator<XBRLArcroleType>` | DTSBase.`getBaseSetArcroles()` An iterator over arcroles in all base sets inside this DTSBase.

    Methods in com.ihr.xbrl.om.exLinks with parameters of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `DTSBaseSet` | DTSBase.`getBaseSet(XBRLArcroleType arcrole)` Returns the DTSBaseSet object for this arcrole Type The DTSBaseSet is a HashSet of XBRLRelationshpis.
    `java.util.Iterator<XBRLRelationship>` | DTSBase.`getBaseSetRelationshipsIterator(XBRLArcroleType arcrole)` Returns an iterator over the relationships in the base set.
    `java.util.Iterator<XBRLRelationship>` | DTSBase.`getBaseSetRelationshipsIterator(XBRLArcroleType arcrole, XBRLValidationReport rep)` Returns an iterator over the relationships in the base set.
    `java.util.Iterator<XBRLRelationship>` | XBRLRelationshipPoint.`getFromRelationships(XBRLArcroleType arcrole, DTSBase base)` Gets the from relationships.
    `DTSBaseSet` | DTSBase.`getIneffectualBaseSet(XBRLArcroleType arcrole, EFMProcessor proc, XBRLValidationReport rep)` This method processes all arcs in a DTSBase and returns all ineffectual relationships in a new constructed instance of a DTSBaseSet.
    `java.util.Iterator<XBRLRelationship>` | XBRLRelationshipPoint.`getToRelationships(XBRLArcroleType arcrole, DTSBase base)` Gets the to relationships.
    `boolean` | DTSBase.`isBaseSetDefined(XBRLArcroleType arcrole)` Returns true if on this DTSbase set there is a DTSBaseSet of relationships for the indicated arcrole, this method does not create an empty base set if it is not defined and does not change the DTS content in any manner.
    `void` | XBRLRelationship.`setArcroleType(XBRLArcroleType arcrole)` Sets the value of the [Arcrole] property of this relationship.

    Constructors in com.ihr.xbrl.om.exLinks with parameters of type XBRLArcroleType
    Constructor and Description
    `XBRLArc(XBRLExtendedLink parent, net.sf.saxon.s9api.XdmNode node, XBRLArcroleType arcroleType)` Creates a new XBRLArc with a surrounding node.
    `XBRLArcroleRef(XBRLDocument parent, XBRLArcroleType arcrole)` Instantiates a new XBRL arcrole ref.
    `XBRLRelationship(XBRLExtendedLink parent, DTSContainer dts, XBRLArcroleType arcroleType, XMLFragment from, XMLFragment to, net.sf.saxon.s9api.XdmNode document, XBRLAttribute[] attributes)` Creates a new relationship object from a XdmNode in a file parent linkbaseType - QName returned by the baseArc.getLinkbaseType()
    `XBRLRelationship(XBRLExtendedLink parent, javax.xml.namespace.QName type, XMLFragment from, XMLFragment to, XBRLArcroleType arcroleType, XBRLAttribute[] attributes, boolean bValidate)` Creates a new relationship object programatically.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.formula

    Methods in com.ihr.xbrl.om.formula that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLFormulaProcessor.`getAssertionSatisfiedMessageArcroleType()` Gets the assertion satisfied message arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getAssertionUnsatisfiedMessageArcroleType()` Gets the assertion unsatisfied message arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getAssetionSetArcroleType()` Gets the assetion set arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getBooleanFilterArcroleType()` Gets the boolean filter arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getConsistencyAssertionFormulaArcroleType()` Gets the consistency assertion formula arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getConsistencyAssertionParameterArcroleType()` Gets the consistency assertion parameter arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getEqualityDefinitionArcroleType()` Gets the equality definition arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getFunctionImplementarionArcroleType()` Gets the function implementarion arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getVariableFilterArcroleType()` Gets the variable filter arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getVariableSetArcroleType()` Gets the variable set arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getVariableSetFilterArcroleType()` Gets the variable set filter arcrole type.
    `XBRLArcroleType` | XBRLFormulaProcessor.`getVariableSetPreconditionArcroleType()` Gets the variable set precondition arcrole type.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.formula.functions.reusable

    Method parameters in com.ihr.xbrl.om.formula.functions.reusable with type arguments of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `static void` | RC_XFI_concept_relationships.`collectRelationships(java.util.ArrayList<XBRLRelationship> relationships, RC_XFI_concept_relationships.Axis axis, XMLElementDefinition concept, java.util.Vector<XBRLRoleType> vRoles, java.util.Vector<XBRLArcroleType> vArcRoles, int generations, net.sf.saxon.value.QNameValue linkName, net.sf.saxon.value.QNameValue arcName)` Collect relationships.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.table

    Methods in com.ihr.xbrl.om.table that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLTableProcessor.`getAspectNodeFilterArcroleType()` Gets the aspect node filter arcrole type.
    `XBRLArcroleType` | XBRLTableProcessor.`getBreakdownTreeArcroleType()` Gets the breakdown tree arcrole type.
    `XBRLArcroleType` | XBRLTableProcessor.`getDefinitionNodeSubtreeArcroleType()` Gets the definition node subtree arcrole type.
    `XBRLArcroleType` | XBRLTableProcessor.`getTableBreakdownArcroleType()` Gets the table breakdown arcrole type.
    `XBRLArcroleType` | XBRLTableProcessor.`getTableFilterArcroleType()` Gets the table filter arcrole type.
    `XBRLArcroleType` | XBRLTableProcessor.`getTableParameterArcroleType()` Access to the table-parameter arcrole defined in this DTS. returns null if the table_parameter arcrole is not defined.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.taxonomy

    Fields in com.ihr.xbrl.om.taxonomy declared as XBRLArcroleType
    Modifier and Type | Field and Description
    --- | ---
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_CONCEPT_LABEL` The standard concept label.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_CONCEPT_REFERENCE` The standard concept reference.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_ESSENCE_ALIAS` The standard essence alias.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_FACT_FOOTNOTE` Static arcroles.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_GENERAL_SPECIAL` The standard general special.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_PARENT_CHILD` The standard parent child.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_REQUIRES_ELEMENT` The standard requires element.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_SIMILAR_TUPLES` The standard similar tuples.
    `static XBRLArcroleType` | XBRLArcroleType.`STANDARD_SUMMATION_ITEM` The standard summation item.

    Methods in com.ihr.xbrl.om.taxonomy that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLTaxonomy.`getArcroleTypeByURI(java.lang.String uri)` Access to an arcrole type definition for a given URI if that arcrole type exists on this taxonomy. returns null if there is no such arcrole type for the given URI.

    Methods in com.ihr.xbrl.om.taxonomy that return types with arguments of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Iterator<XBRLArcroleType>` | XBRLTaxonomy.`getArcroleTypes()` Returns an iterator over all arcrole types defined in this taxonomy.

    Methods in com.ihr.xbrl.om.taxonomy with parameters of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `void` | XBRLTaxonomy.`addArcroleType(XBRLArcroleType arcrole)` Adds a new arcrole type to the set of arcrole types defined in this taxonomy.
    `void` | XBRLTaxonomy.`removeArcroleType(XBRLArcroleType arcrole)` Removes an arcrole type from the set of arcrole types defined in this taxonomy.

    Constructors in com.ihr.xbrl.om.taxonomy with parameters of type XBRLArcroleType
    Constructor and Description
    `XBRLArcroleType(DTSContainer newDTS, XBRLArcroleType other)` Instantiates a new XBRL arcrole type.
    `XBRLArcroleType(XBRLArcroleType other)` Instantiates a new XBRL arcrole type.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.om.xdt

    Methods in com.ihr.xbrl.om.xdt that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XDTProcessor.`getArcroleTypeAll()` Gets the arcrole type all.
    `XBRLArcroleType` | XDTProcessor.`getArcroleTypeDimensionDefault()` Gets the arcrole type dimension default.
    `XBRLArcroleType` | XDTProcessor.`getArcroleTypeDimensionDomain()` Gets the arcrole type dimension domain.
    `XBRLArcroleType` | XDTProcessor.`getArcroleTypeDomainMember()` Gets the arcrole type domain member.
    `XBRLArcroleType` | XDTProcessor.`getArcroleTypeHypercubeDimension()` Gets the arcrole type hypercube dimension.
    `XBRLArcroleType` | XDTProcessor.`getArcroleTypeNotAll()` Gets the arcrole type not all.

  - ### Uses of XBRLArcroleType in com.ihr.xbrl.pojo

    Methods in com.ihr.xbrl.pojo that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLRSGenerator.`generate(XBRLArcroleType arcrole, java.lang.String key)` Generate.

    Methods in com.ihr.xbrl.pojo with parameters of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | XBRLPojoGenerator.`generate(XBRLArcroleType dtsArcroleType)` Generate.

  - ### Uses of XBRLArcroleType in com.rs.xbrl

    Methods in com.rs.xbrl that return XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `XBRLArcroleType` | TaxonomyBuilder.`getArcroleType(GenerationContext gc, java.lang.String arcrole)` Returns an arcrole type in the DTS from the arcrole type URI

    Methods in com.rs.xbrl with parameters of type XBRLArcroleType
    Modifier and Type | Method and Description
    --- | ---
    `void` | TaxonomyBuilder.`generateGenericArc(GenerationContext gc, XBRLArcroleType arcroleT, XMLFragment xfrom, XMLFragment xto, XBRLAttribute[] attributes)`