6.8.1 XBRLArcroleTypeインターフェース

public interface XBRLArcroleType
extends XBRLTaxonomyNode

XBRLのバージョン:
2.1
説明:
カスタムアークロールを定義する<link:arcroleType>要素を表します。
メソッドの概要:
XBRLArcroleTypeインターフェースのメソッドの概要を次の表に示します。

表6-88 XBRLArcroleTypeインターフェースのメソッドの概要

項番説明XBRLのバージョン
1java.lang.StringgetId()
  <link:arcroleType>要素のid属性の値を取得します。
2.1
2java.lang.StringgetArcroleURI()
  カスタムアークロールのarcroleURI属性の値を取得します。
2.1
3java.lang.StringgetCyclesAllowed()
  <link:arcroleType>要素のcyclesAllowed属性の値を取得します。
2.1
4java.util.List<XBRLQName>getUsedOn()
  カスタムアークロールを使用できる要素のリストを取得します。
2.1
5booleanisUsedOn(java.lang.String namespaceURI, java.lang.String name)
  指定した要素で,カスタムアークロールが使用できるかどうかを調べます。
2.1
<この項の構成>
(1) getId
(2) getArcroleURI
(3) getCyclesAllowed
(4) getUsedOn
(5) isUsedOn

(1) getId

public java.lang.String getId()

XBRLのバージョン:
2.1
説明:
<link:arcroleType>要素のid属性の値を取得します。
戻り値:
この<link:arcroleType>要素のid属性の値を返します。この<link:arcroleType>要素にid属性がない場合はnullを返します。

(2) getArcroleURI

public java.lang.String getArcroleURI()

XBRLのバージョン:
2.1
説明:
カスタムアークロールのarcroleURI属性の値を取得します。
戻り値:
この<link:arcroleType>要素によって定義されるカスタムアークロールのarcroleURI属性の値を返します。

(3) getCyclesAllowed

public java.lang.String getCyclesAllowed()

XBRLのバージョン:
2.1
説明:
<link:arcroleType>要素のcyclesAllowed属性の値を取得します。
cyclesAllowed属性の値は,カスタムアークロールを使用して記述された関係のネットワークで,どの種類のサイクルが許可されるかを示します。
戻り値:
この<link:arcroleType>要素のcyclesAllowed属性の値を返します。

(4) getUsedOn

public java.util.List<XBRLQName> getUsedOn()

XBRLのバージョン:
2.1
説明:
カスタムアークロールを使用できる要素のリストを取得します。
このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
戻り値:
この<link:arcroleType>要素によって定義されるカスタムアークロールを使用できる要素のリストを返します。リストにはXBRLQNameオブジェクトが格納されていて,各XBRLQNameオブジェクトは,カスタムアークロールを使用できる要素の名前空間URIと要素名を保持します。

(5) isUsedOn

public boolean isUsedOn(java.lang.String namespaceURI,
                       java.lang.String name)

XBRLのバージョン:
2.1
説明:
指定した要素で,カスタムアークロールが使用できるかどうかを調べます。
引数:
namespaceURI - 要素の名前空間URIを指定します。
name - 要素の名前を指定します。
戻り値:
この<link:roleType>要素によって定義されるカスタムアークロールが,引数で指定した要素で利用できる場合はtrue,利用できない場合はfalseを返します。
例外:
XBRLDOMRuntimeException -
  • 引数nameにnullを指定した場合にスローされます。[エラーコード:20002]