6.11.5 SimpleLabelインターフェース
public interface SimpleLabel
extends SimpleNode
- XBRLのバージョン:
- 2.1
- 説明:
- 単純なタクソノミー文書を構成するラベル要素を表します。
- メソッドの概要:
- SimpleLabelインターフェースのメソッドの概要を次の表に示します。
表6-183 SimpleLabelインターフェースのメソッドの概要
項番 | 説明 | XBRLのバージョン |
---|
1 | java.lang.String | getRole() ラベル要素(link:label)のxlink:role属性値を取得します。 | 2.1 |
2 | void | setRole(java.lang.String role) ラベル要素(link:label)のxlink:role属性値を設定します。 | 2.1 |
3 | java.lang.String | getLang() ラベル要素(link:label)のxml:lang属性値を取得します。 | 2.1 |
4 | void | setLang(java.lang.String lang) ラベル要素(link:label)のxml:lang属性値を設定します。 | 2.1 |
5 | java.lang.String | getTitle() ラベル要素(link:label)のxlink:title属性値を取得します。 | 2.1 |
6 | void | setTitle(java.lang.String title) ラベル要素(link:label)のxlink:title属性値を設定します。 | 2.1 |
7 | java.lang.String | getId() ラベル要素(link:label)のid属性値を取得します。 | 2.1 |
8 | void | setId(java.lang.String id) ラベル要素(link:label)のid属性値を設定します。 | 2.1 |
9 | java.lang.String | getValue() ラベル要素(link:label)の内容を取得します。 | 2.1 |
10 | void | setValue(java.lang.String value) ラベル要素(link:label)の内容を設定します。 | 2.1 |
- <この項の構成>
- (1) getRole
- (2) setRole
- (3) getLang
- (4) setLang
- (5) getTitle
- (6) setTitle
- (7) getId
- (8) setId
- (9) getValue
- (10) setValue
(1) getRole
public java.lang.String getRole()
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のxlink:role属性値を取得します。xlink:role属性値は生成時には設定されないため,生成直後にこのメソッドを実行した場合にはnullを返します。
- 戻り値:
- ラベル要素(link:label)のxlink:role属性値を返します。
- xlink:role属性値が設定されていない場合には,nullを返します。
(2) setRole
public void setRole(java.lang.String role)
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のxlink:role属性値を設定します。次に示す標準値とカスタムロール値が設定できます。ラベル要素(link:label)からxlink:role属性を削除する場合には,nullを指定してください。
- 設定できるカスタムロール値
- 設定できるカスタムロール値は,拡張元であるXBRLTaxonomyDocumentオブジェクトのgetRoleTypes()メソッドで取得されるXBRLRoleTypeオブジェクトのうち,getUsedOn()メソッドで取得されるリストに次の値を含む,XBRLRoleTypeオブジェクトのgetRoleURI()メソッドで取得される値です。
- 名前空間:http://www.xbrl.org/2003/linkbase
- ローカル名:label
- 設定できる標準値
- 設定できる標準値は次のとおりです。
- http://www.xbrl.org/2003/role/label
- http://www.xbrl.org/2003/role/terseLabel
- http://www.xbrl.org/2003/role/verboseLabel
- http://www.xbrl.org/2003/role/positiveLabel
- http://www.xbrl.org/2003/role/positiveTerseLabel
- http://www.xbrl.org/2003/role/positiveVerboseLabel
- http://www.xbrl.org/2003/role/negativeLabel
- http://www.xbrl.org/2003/role/negativeTerseLabel
- http://www.xbrl.org/2003/role/negativeVerboseLabel
- http://www.xbrl.org/2003/role/zeroLabel
- http://www.xbrl.org/2003/role/zeroTerseLabel
- http://www.xbrl.org/2003/role/zeroVerboseLabel
- http://www.xbrl.org/2003/role/totalLabel
- http://www.xbrl.org/2003/role/periodStartLabel
- http://www.xbrl.org/2003/role/periodEndLabel
- http://www.xbrl.org/2003/role/documentation
- http://www.xbrl.org/2003/role/definitionGuidance
- http://www.xbrl.org/2003/role/disclosureGuidance
- http://www.xbrl.org/2003/role/presentationGuidance
- http://www.xbrl.org/2003/role/measurementGuidance
- http://www.xbrl.org/2003/role/commentaryGuidance
- http://www.xbrl.org/2003/role/exampleGuidance
- 引数:
- role - ラベル要素(link:label)のxlink:role属性値を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数roleに指定できない値が指定されている場合にスローされます。[エラーコード:20156]
(3) getLang
public java.lang.String getLang()
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のxml:lang属性値を取得します。
- 戻り値:
- ラベル要素(link:label)のxml:lang属性値を返します。
(4) setLang
public void setLang(java.lang.String lang)
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のxml:lang属性値を設定します。
- 引数:
- lang - ラベル要素(link:label)のxml:lang属性値を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数langにnullを指定した場合にスローされます。[エラーコード:20002]
(5) getTitle
public java.lang.String getTitle()
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のxlink:title属性値を取得します。xlink:title属性値はオブジェクト生成時には設定されないため,生成直後にこのメソッドを実行した場合には,nullを返します。
- 戻り値:
- ラベル要素(link:label)のxml:title属性値を返します。xlink:title属性値が設定されていない場合には,nullを返します。
(6) setTitle
public void setTitle(java.lang.String title)
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のxlink:title属性値を設定します。ラベル要素からxlink:title属性を削除する場合には,nullを指定します。
- 引数:
- title - ラベル要素(link:label)のxlink:title属性値を指定します。
(7) getId
public java.lang.String getId()
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のid属性値を取得します。id属性値はオブジェクト生成時には設定されないため,生成直後にこのメソッドを実行した場合には,nullを返します。
- 戻り値:
- ラベル要素(link:label)のid属性値を返します。id属性値が設定されていない場合には,nullを返します。
(8) setId
public void setId(java.lang.String id)
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)のid属性値を設定します。ラベル要素からid属性を削除する場合には,nullを指定します。
- 引数:
- id - このラベル要素(link:label)のid属性値を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数idに空文字列("")またはxsd:NCNameとして不正な文字列が指定された場合にスローされます。[エラーコード:20108]
- 次の二つの条件を同時に満たす場合にスローされます。[エラーコード:22003]
・このSimpleLabelオブジェクトがアクティブである場合
・このSimpleLabelオブジェクトを所有するSimpleTaxonomyオブジェクトの中に,引数idで指定されたid属性値を持つ別のアクティブなSimpleLabelオブジェクトが存在する場合
(9) getValue
public String getValue()
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)の内容を取得します。
- 戻り値:
- ラベル要素(link:label)の内容を返します。
(10) setValue
public void setValue(java.lang.String value)
- XBRLのバージョン:
- 2.1
- 説明:
- ラベル要素(link:label)の内容を設定します。
- 引数:
- value - ラベル要素(link:label)の内容を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数valueにnullを指定した場合にスローされます。[エラーコード:20002]