6.8.8 XBRLRoleTypeインターフェース

public interface XBRLRoleType
extends XBRLTaxonomyNode

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

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

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

(1) getId

public java.lang.String getId()

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

(2) getRoleURI

public java.lang.String getRoleURI()

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

(3) getUsedOn

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

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

(4) 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]