6.6.5 XBRLFootnoteインターフェース
(1) getFootnoteLinkRole
public java.lang.String getFootnoteLinkRole()
- XBRLのバージョン:
- 2.1
- 説明:
- 脚注が属する脚注リンクのロールを取得します。
- 戻り値:
- この脚注が属する脚注リンクのロールを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
(2) getLang
public java.lang.String getLang()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注の言語を取得します。
- 戻り値:
- この脚注の言語を表すxml:lang属性の値を返します。
(3) setLang
public void setLang(java.lang.String lang)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注の言語を設定します。
- 引数:
- lang - この脚注の言語を表すxml:lang属性の値を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数langにnullを指定した場合にスローされます。[エラーコード:20002]
(4) getRole
public java.lang.String getRole()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注のロール(役割)を取得します。脚注のロールは,<link:footnote>要素のxlink:role属性の値です。
- 戻り値:
- この脚注のロールを表すxlink:role属性の値を返します。xlink:role属性の値がない場合はnullを返します。
(5) setRole
public void setRole(java.lang.String role)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注のロール(役割)を設定します。脚注のロールは,<link:footnote>要素のxlink:role属性の値です。
- 引数:
- role - この脚注のロールを指定します。ロールを削除する場合はnullを指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数roleに指定した値がxsd:anyURI型でない場合にスローされます。[エラーコード:20108]
- 引数roleに指定した値が絶対URIでない場合にスローされます。[エラーコード:20109]
- XBRL2.1の場合:引数roleに指定したロールがXBRL仕様で規定された標準値で,かつ,脚注で利用できる値ではない場合にスローされます。[エラーコード:20115]
- XBRL2.1の場合:引数roleに指定したロールがカスタムロールで,かつ,そのカスタムロールの定義を指す<link:roleRef>要素がインスタンス文書に記述されていない場合にスローされます。[エラーコード:20117]
- XBRL2.1の場合:引数roleに指定したロールがカスタムロールで,かつ,<link:roleType>要素でそのカスタムロールが脚注で利用できるように定義されていない場合にスローされます。[エラーコード:20119]
(6) getTitle
public java.lang.String getTitle()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注のタイトルを取得します。脚注のタイトルは,<link:footnote>要素のxlink:title属性の値です。
- 戻り値:
- この脚注のタイトルを表すxlink:title属性の値を返します。xlink:title属性の値がない場合はnullを返します。
(7) setTitle
public void setTitle(java.lang.String title)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注のタイトルを設定します。脚注のタイトルは,<link:footnote>要素のxlink:title属性の値です。
- 引数:
- title - この脚注のタイトルを指定します。タイトルを削除する場合はnullを指定します。
(8) getId
public java.lang.String getId()
- XBRLのバージョン:
- 2.1
- 説明:
- 脚注のid属性を取得します。
- 戻り値:
- 脚注のid属性の値を返します。id属性がない場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
(9) setId
public void setId(java.lang.String id)
- XBRLのバージョン:
- 2.1
- 説明:
- 脚注のid属性を設定します。
- 引数:
- id - この脚注のid属性の値を指定します。id属性を削除する場合は,nullを指定します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 引数idに指定した値がxsd:NCName型でない場合にスローされます。[エラーコード:20108]
- この脚注がインスタンス文書中に記述されていて,かつ,引数idで指定されたのと同じ値を持つxsd:ID型属性がインスタンス文書中にすでに記述されている場合にスローされます。[エラーコード:20028]
(10) getValue
public java.lang.String getValue()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注の内容を表す文字列を取得します。
- 脚注の内容にXHTMLのタグが含まれている場合,このメソッドはnullを返します。脚注の内容に含まれるXHTMLのタグを参照したい場合は,getContainerNode()メソッドを使用してください。
- 戻り値:
- 脚注の内容を表す文字列を返します。脚注の内容にXHTMLのタグが含まれている場合はnullを返します。
(11) setValue
public void setValue(java.lang.String value)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注の内容を表す文字列を設定します。
- 引数valueに,XHTMLのタグを含む文字列を指定しても,脚注の内容にはXHTMLのタグは生成されません。脚注にXHTMLのタグを含む内容を設定したい場合は,getContainerNode()メソッドでorg.w3c.dom.Nodeオブジェクトを取得し,その子ノードおよび子孫ノードとしてXHTMLのタグを表すorg.w3c.dom.Nodeオブジェクトを追加します。
- 引数:
- value - この脚注の内容を表す文字列を指定します。
- 例外:
- XBRLDOMRuntimeException -
- 引数valueにnullを指定した場合にスローされます。[エラーコード:20002]
(12) getContainerNode
public org.w3c.dom.Node getContainerNode()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注の内容を保持するorg.w3c.dom.Nodeオブジェクトを取得します。
- このメソッドが返すorg.w3c.dom.Nodeオブジェクトの子孫ノード以外のノードに対して,更新を伴う操作をしないでください。このメソッドが返すorg.w3c.dom.Nodeオブジェクトの子孫ノードだけを更新できます。
- 戻り値:
- この脚注の内容を保持するorg.w3c.dom.Nodeオブジェクトを返します。
(13) getElements
public java.util.List<XBRLInstanceElement> getElements()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 脚注と関連づけられている要素のリストを取得します。要素は,アイテムまたはタプルです。
- この脚注と関連づけられている要素には,インスタンス文書にない,XBRLInstanceNode.isActive()がfalseを返すノードも含まれます。
- このメソッドが返す要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる要素に増減があった場合,その変更は直ちに反映されます。また,このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- この脚注と関連づけられている要素をすべて含む,XBRLInstanceElementオブジェクトのリストを返します。この脚注と関連づけられている要素がない場合は,要素数が0のリストを返します。
(14) getElements
public java.util.List<XBRLInstanceElement> getElements(java.lang.String namespaceURI,
java.lang.String name)
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- この脚注と関連づけられている,指定された名前を持つ要素のリストを取得します。要素は,アイテムまたはタプルです。
- この脚注と関連づけられている要素には,インスタンス文書にない,XBRLInstanceNode.isActive()がfalseを返すノードも含まれます。
- このメソッドが返す要素のリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれる要素に増減があった場合,その変更は直ちに反映されます。このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとすると,java.lang.UnsupportedOperationExceptionがスローされます。
- 引数:
- namespaceURI - 要素の名前空間URIを指定します。
- name - 要素の名前を指定します。
- 戻り値:
- 引数namespaceURIで指定した名前空間URIに属し,引数nameで指定した名前を持つ要素を表すXBRLInstanceElementオブジェクトのリストを返します。指定した要素がない場合は,要素数が0のリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- 引数namespaceURIまたはnameにnullを指定した場合にスローされます。[エラーコード:20002]