6.6.4 XBRLEntityインターフェース

public interface XBRLEntity
extends XBRLInstanceNode

XBRLのバージョン:
2.0および2.1
説明:
エンティティ要素を表します。
メソッドの概要:
XBRLEntityインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1XBRLIdentifiergetIdentifier()
  識別子要素を取得します。
2.0および2.1
2voidsetIdentifier(XBRLIdentifier identifier)
  識別子要素を設定します。
2.0および2.1
3XBRLSegmentgetSegment()
  セグメント要素を取得します。
2.0および2.1
4voidsetSegment(XBRLSegment segment)
  セグメント要素を設定します。
2.0および2.1
<この項の構成>
(1) getIdentifier
(2) setIdentifier
(3) getSegment
(4) setSegment

(1) getIdentifier

public XBRLIdentifier getIdentifier()

XBRLのバージョン:
2.0および2.1
説明:
識別子要素を取得します。
戻り値:
識別子要素を表すXBRLIdentifierオブジェクトを返します。

(2) setIdentifier

public void setIdentifier(XBRLIdentifier identifier)

XBRLのバージョン:
2.0および2.1
説明:
識別子要素を設定します。
このXBRLEntityオブジェクトにすでに設定されているXBRLIdentifierオブジェクトは,親がいない状態となり,getParentNode()メソッドがnullを返します。
引数:
identifier - 識別子要素を表すXBRLIdentifierオブジェクトを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数identifierにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数identifierに指定したXBRLIdentifierオブジェクトを所有しているXBRLInstanceDocumentオブジェクトがこのXBRLEntityオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
  • 引数identifierに指定したXBRLIdentifierオブジェクトがすでにほかのXBRLEntityオブジェクトに設定されている場合にスローされます。[エラーコード:20005]

(3) getSegment

public XBRLSegment getSegment()

XBRLのバージョン:
2.0および2.1
説明:
セグメント要素を取得します。
戻り値:
セグメント要素を表すXBRLSegmentオブジェクトを返します。セグメント要素がない場合はnullを返します。

(4) setSegment

public void setSegment(XBRLSegment segment)

XBRLのバージョン:
2.0および2.1
説明:
セグメント要素を設定します。
このXBRLEntityオブジェクトにXBRLSegmentオブジェクトが設定されている場合,そのオブジェクトは親がいない状態となり,getParentNode()メソッドがnullを返します。
引数:
segment - セグメント要素を表すXBRLSegmentオブジェクトを指定します。セグメント要素を削除する場合はnullを指定します。
例外:
XBRLDOMRuntimeException -
  • 引数segmentに指定したXBRLSegmentオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLEntityオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
  • 引数segmentに指定したXBRLSegmentオブジェクトが,すでにほかのXBRLEntityオブジェクトに設定されている場合にスローされます。[エラーコード:20005]