6.6.23 XBRLRoleRefインターフェース
public interface XBRLRoleRef
extends XBRLInstanceNode
- XBRLのバージョン:
- 2.1
- 説明:
- インスタンス文書に記述されている<link:roleRef>要素を表します。
- メソッドの概要:
- XBRLRoleRefインターフェースのメソッドの概要を次の表に示します。
表6-56 XBRLRoleRefインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | java.lang.String | getHref() <link:roleRef>要素のxlink:href属性の値を取得します。 | 2.1 |
2 | java.lang.String | getRoleURI() <link:roleRef>要素のroleURI属性の値を取得します。 | 2.1 |
3 | java.lang.String | getBase() <link:roleRef>要素のxml:base属性の値を取得します。 | 2.1 |
4 | XBRLRoleType | getRoleType() <link:roleRef>要素のlink:roleType属性の値を取得します。 | 2.1 |
- <この項の構成>
- (1) getHref
- (2) getRoleURI
- (3) getBase
- (4) getRoleType
(1) getHref
public java.lang.String getHref()
- XBRLのバージョン:
- 2.1
- 説明:
- <link:roleRef>要素のxlink:href属性の値を取得します。xlink:href属性は,この<link:roleRef>要素が参照する特定の<link:roleType>要素を指します。
- 戻り値:
- この<link:roleRef>要素のxlink:href属性の値を返します。
(2) getRoleURI
public java.lang.String getRoleURI()
- XBRLのバージョン:
- 2.1
- 説明:
- <link:roleRef>要素のroleURI属性の値を取得します。roleURI属性の値は,この<link:roleRef>要素が指す<link:roleType>要素で定義されるカスタムロールの値と同じです。
- 戻り値:
- この<link:roleRef>要素のroleURI属性の値を返します。
(3) getBase
public java.lang.String getBase()
- XBRLのバージョン:
- 2.1
- 説明:
- <link:roleRef>要素のxml:base属性の値を取得します。
- 戻り値:
- この<link:roleRef>要素のxml:base属性の値を返します。xml:base属性がない場合はnullを返します。
(4) getRoleType
public XBRLRoleType getRoleType()
- XBRLのバージョン:
- 2.1
- 説明:
- <link:roleRef>要素のlink:roleType属性の値を取得します。
- このメソッドは,このXBRLRoleRefオブジェクトがアクティブである場合にだけ呼び出せます。このXBRLRoleRefオブジェクトが非アクティブである場合にこのメソッドを呼び出した場合は,XBRLDOMRuntimeExceptionがスローされます。
- 戻り値:
- この<link:roleRef>要素が指す<link:roleType>要素を表すXBRLRoleTypeオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- このXBRLRoleRefオブジェクトが非アクティブである場合にスローされます。[エラーコード:20121]