6.11.3 SimpleElementDefinitionインターフェース

public interface SimpleElementDefinition
extends SimpleNode

XBRLのバージョン:
2.1
説明:
単純なタクソノミー文書を構成する要素定義を表すインターフェースです。
メソッドの概要:
SimpleElementDefinitionインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1java.lang.StringgetName()
  要素定義のname属性値を取得します。
2.1
2voidsetName(java.lang.String name)
  要素定義のname属性値を設定します。
2.1
3java.lang.StringgetType()
  要素定義のtype属性値を取得します。
2.1
4java.lang.StringgetId()
  要素定義のid属性値を取得します。
2.1
5voidsetId(java.lang.String id)
  要素定義のid属性値を設定します。
2.1
6booleangetAbstract()
  要素定義のabstract属性値を取得します。
2.1
7voidsetAbstract(boolean abstrakt)
  要素定義のabstract属性値を設定します。
2.1
8booleangetNillable()
  要素定義のnillable属性値を取得します。
2.1
9voidsetNillable(boolean nillable)
  要素定義のnillable属性値を設定します。
2.1
10java.lang.StringgetSubstitutionGroup()
  要素定義のsubstitutionGroup属性値を取得します。
2.1
<この項の構成>
(1) getName
(2) setName
(3) getType
(4) getId
(5) setId
(6) getAbstract
(7) setAbstract
(8) getNillable
(9) setNillable
(10) getSubstitutionGroup

(1) getName

public java.lang.String getName()

XBRLのバージョン:
2.1
説明:
要素定義のname属性値を取得します。
戻り値:
要素定義のname属性値を返します。

(2) setName

public void setName(java.lang.String name)

XBRLのバージョン:
2.1
説明:
要素定義のname属性値を設定します。
引数:
name - 要素定義のname属性値を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数nameにnullを指定した場合にスローされます。[エラーコード:20002]
  • 引数nameに空文字列("")またはxsd:NCNameとして不正な文字列が指定された場合にスローされます。[エラーコード:20108]
  • 次のどちらかの条件に該当する場合にスローされます。[エラーコード:22002]
    ・このSimpleElementDefinitionオブジェクトがアクティブであり,かつこのSimpleElementDefinitionオブジェクトを所有するSimpleTaxonomyオブジェクトの中に,引数nameで指定されたname属性値を持つ別のアクティブなSimpleElementDefinitionオブジェクトが存在する場合
    ・同じ対象名前空間で同じname属性値を持つXBRLTaxonomyElementオブジェクトが,拡張元であるXBRLTaxonomyDocumentオブジェクトに存在する場合

(3) getType

public java.lang.String getType()

XBRLのバージョン:
2.1
説明:
要素定義のtype属性値を取得します。
戻り値:
要素定義のtype属性値を返します。

(4) getId

public java.lang.String getId()

XBRLのバージョン:
2.1
説明:
要素定義のid属性値を取得します。
注 id属性値には,このオブジェクトを所有するSimpleTaxonomyオブジェクトのgetPrefix()で取得される接頭辞と,オブジェクト生成時に指定したname属性値とを"_"で連結した文字列が設定されています。例えば,接頭辞がhi,name属性値がbalanceSheetの場合,id属性値はhi_balanceSheetと設定されています。
戻り値:
要素定義のid属性値を返します。

(5) setId

public void setId(java.lang.String id)

XBRLのバージョン:
2.1
説明:
要素定義のid属性値を設定します。
引数:
id - 要素定義のid属性値を指定します。
例外:
XBRLDOMRuntimeException -
  • 引数idに空文字列("")またはxsd:NCNameとして不正な文字列が指定された場合にスローされます。[エラーコード:20108]
  • 次の二つの条件を同時に満たす場合にスローされます。[エラーコード:22003]
    ・このSimpleElementDefinitionオブジェクトがアクティブである場合
    ・このSimpleElementDefinitionオブジェクトを所有するSimpleTaxonomyオブジェクトの中に,引数idで指定されたid属性値を持つ別のアクティブなSimpleElementDefinitionオブジェクトが存在する場合
  • 引数idにnullを指定した場合にスローされます。[エラーコード:20002]

(6) getAbstract

public boolean getAbstract()

XBRLのバージョン:
2.1
説明:
要素定義のabstract属性値を取得します。
注 初期状態ではfalseが設定されています。
戻り値:
要素定義のabstract属性値を返します。

(7) setAbstract

public void setAbstract(boolean abstrakt)

XBRLのバージョン:
2.1
説明:
要素定義のabstract属性値を設定します。
abstract属性値がfalseの場合,実際のタクソノミー文書ではこの属性は設定されないで,省略されます。
引数:
abstrakt - 要素定義のabstract属性値を指定します。

(8) getNillable

public boolean getNillable()

XBRLのバージョン:
2.1
説明:
要素定義のnillable属性値を取得します。
注 初期状態ではfalseが設定されています。
戻り値:
要素定義のnillable属性値を返します。

(9) setNillable

public void setNillable(boolean nillable)

XBRLのバージョン:
2.1
説明:
要素定義のnillable属性値を設定します。
nillable属性値がfalseの場合,実際のタクソノミー文書ではこの属性は設定されないで省略されます。
引数:
nillable - 要素定義のnillable属性値を指定します。

(10) getSubstitutionGroup

public java.lang.String getSubstitutionGroup()

XBRLのバージョン:
2.1
説明:
要素定義のsubstitutionGroup属性値を取得します。要素定義とその戻り値を次の表に示します。

表6-180 getSubstitutionGroupの要素定義と戻り値

要素定義戻り値
アイテム"xbrli:item"
戻り値:
要素定義のsubstitutionGroup属性値を返します。