6.6.24 XBRLScenarioインターフェース
(1) getName
public java.lang.String getName()
- XBRLのバージョン:
- 2.0
- 説明:
- シナリオ要素のname属性を取得します。
- 戻り値:
- name属性の値を返します。name属性がない場合はnullを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
(2) setName
public void setName(java.lang.String name)
- XBRLのバージョン:
- 2.0
- 説明:
- シナリオ要素のname属性を設定します。
- 引数:
- name - name属性の値を指定します。name属性を削除する場合はnullを指定します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.0でない場合にスローされます。[エラーコード:20100]
(3) getContainerNode
public org.w3c.dom.Node getContainerNode()
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- シナリオ要素の内容を保持するノードを取得します。
- このメソッドが返すノードの子孫ノード以外のノードに対して,更新を伴う操作を行ってはいけません。このメソッドが返すノードの子孫ノードだけを更新できます。
- XBRL2.1の場合:シナリオ要素の内容に関する制約
- XBRLの仕様では,シナリオ要素の内容に次の制約があります。
- シナリオ要素の内容には,http://www.xbrl.org/2003/instanceの名前空間に属する要素が含まれてはいけません。
- シナリオ要素の内容には,http://www.xbrl.org/2003/instanceの名前空間に属する要素の代替要素が含まれてはいけません。
- シナリオ要素の内容が空ではいけません。つまり,シナリオ要素は一つ以上の子要素を持つ必要があります。
- XBRL DOMでインスタンス文書を編集する際,上記の制約についてはチェックされません。このため,シナリオ要素の内容を上記の制約に従っていない状態にすることもできます。しかし,シナリオ要素の内容が上記の制約に従っていない場合には,インスタンス文書をストリームへ出力してから再度解析した際にエラーが発生するおそれがあります。
- そのため,このメソッドが返したorg.w3c.dom.Nodeオブジェクトを使用してシナリオ要素の内容を編集する場合は,上記の制約に違反しないように注意してください。
- XBRL Dimensions1.0の場合
- このメソッドが返したorg.w3c.dom.Nodeオブジェクトを使用して次の操作を実行した場合,XBRLScenarioインターフェースのgetDimensionMembersメソッド,getExplicitMemberメソッドおよびgetTypedMemberメソッドで取得できるリストに操作内容は反映されません。
- シナリオ要素の内容に,<xbrldi:explicitMember>要素または<xbrldi:typedMember>要素を追加する
- シナリオ要素の内容である<xbrldi:explicitMember>要素または<xbrldi:typedMember>要素を編集する
- 戻り値:
- このシナリオ要素の内容を保持するorg.w3c.dom.Nodeオブジェクトを返します。
(4) getDimensionMembers
public java.util.List<XBRLDimensionMember> getDimensionMembers()
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素である<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素のリストを取得します。
- このメソッドが返すリスト中でのXBRLDimensionMemberオブジェクトの順序は,インスタンス文書の要素の出現順と同じです。XBRLDimensionMemberオブジェクトは,<xbrldi:explicitMember>要素の場合はXBRLExplicitMemberオブジェクトになり,<xbrldi:typedMember>要素の場合はXBRLTypedMemberオブジェクトになります。
- このメソッドが返すXBRLDimensionMemberオブジェクトのリストはライブオブジェクトです。このメソッドを呼び出したあとに,このメソッドが返したリストに含まれるXBRLDimensionMemberオブジェクトに増減があった場合,その変更は直ちに反映されます。このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- このシナリオ要素の子要素である<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素をすべて含むXBRLDimensionMemberオブジェクトのリストを返します。このシナリオ要素の子要素に<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素が存在しない場合は,要素数が0であるリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
(5) getExplicitMembers
public java.util.List<XBRLExplicitMember> getExplicitMembers()
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素である<xbrldi:explicitMember>要素のリストを取得します。
- このメソッドが返すリスト中でのXBRLExplicitMemberオブジェクトの順序は,インスタンス文書における要素の出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- このシナリオ要素の子要素である<xbrldi:explicitMember>要素をすべて含むXBRLExplicitMemberオブジェクトのリストを返します。このシナリオ要素の子要素に<xbrldi:explicitMember>要素が存在しない場合は,要素数が0であるリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
(6) getTypedMembers
public java.util.List<XBRLTypedMember> getTypedMembers()
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素である<xbrldi:typedMember>要素のリストを取得します。
- このメソッドが返すリスト中でのXBRLTypedMemberオブジェクトの順序は,インスタンス文書における要素の出現順と同じです。
- このメソッドが返すリストは読み取り専用です。このメソッドが返したリストを変更しようとするとjava.lang.UnsupportedOperationExceptionがスローされます。
- 戻り値:
- このシナリオ要素の子要素である<xbrldi:typedMember>要素をすべて含むXBRLTypedMemberオブジェクトのリストを返します。このシナリオ要素の子要素に<xbrldi:typedMember>要素が存在しない場合は,要素数が0であるリストを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
(7) appendDimensionMember
public XBRLDimensionMember appendDimensionMember(XBRLDimensionMember newMember)
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素である<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素のリストの末尾に,引数newMemberに指定された要素を追加します。
- 指定された要素がすでにほかのオブジェクトの子要素となっている場合は,最初に既存の親から指定した要素が削除されます。
- 引数:
- newMember - 追加する子要素を表すXBRLDimensionMemberオブジェクトを指定します。
- 戻り値:
- 追加された子要素を表すXBRLDimensionMemberオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数newMemberにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数newMemberに指定したXBRLDimensionMemberオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLScenarioオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
(8) insertDimensionMemberBefore
public XBRLDimensionMember insertDimensionMemberBefore(XBRLDimensionMember newMember,
XBRLDimensionMember refMember )
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- 引数newMemberに指定された要素を,引数refMemberに指定された子要素の前に挿入します。
- 引数refMemberがnullの場合は,引数newMemberに指定した要素は,このシナリオ要素の子要素である<xbrldi:explicitMember>要素および<xbrldi:typedMember>要素のリストの末尾に挿入されます。指定された要素がすでにほかのオブジェクトの子要素となっている場合は,最初に既存の親から指定した要素が削除されます。引数newMemberに指定されたXBRLDimensionMemberオブジェクトが引数refMemberに指定したXBRLDimensionMemberオブジェクトと同じ場合は,このメソッドは何もしません。
- 引数:
- newMember - 挿入する子要素を表すXBRLDimensionMemberオブジェクトを指定します。
- refMember - 参照する子要素を表すXBRLDimensionMemberオブジェクトを指定します。引数newMemberで指定した子要素は,この子要素の直前に挿入されます。
- 戻り値:
- 挿入された子要素を表すXBRLDimensionMemberオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数newMemberにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数newMemberに指定したXBRLDimensionMemberオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLScenarioオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
- 引数refMemberに指定した子要素が,このシナリオ要素の子要素でない場合にスローされます。[エラーコード:22104]
(9) replaceDimensionMember
public XBRLDimensionMember replaceDimensionMember(XBRLDimensionMember newMember,
XBRLDimensionMember oldMember)
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- 引数oldMemberに指定された子要素を,引数newMemberに指定した要素で置き換えます。
- 指定した要素がすでにほかのオブジェクトの子要素となっている場合は,最初に既存の親から指定した要素が削除されます。引数newMemberに指定したXBRLDimensionMemberオブジェクトが引数oldMemberに指定したXBRLDimensionMemberオブジェクトと同じ場合は,このメソッドは何もしません。
- 引数:
- newMember - 挿入する子要素を表すXBRLDimensionMemberオブジェクトを指定します。
- oldMember - 置き換えの対象となる子要素を表すXBRLDimensionMemberオブジェクトを指定します。
- 戻り値:
- 置き換えの対象となった子要素を表すXBRLDimensionMemberオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数newMemberまたはoldMemberにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数newMemberに指定したXBRLDimensionMemberオブジェクトを所有しているXBRLInstanceDocumentオブジェクトが,このXBRLScenarioオブジェクトを所有しているXBRLInstanceDocumentオブジェクトと異なる場合にスローされます。[エラーコード:20004]
- 引数oldMemberに指定した子要素が,このシナリオ要素の子要素でない場合にスローされます。[エラーコード:22104]
(10) removeDimensionMember
public XBRLDimensionMember removeDimensionMember(XBRLDimensionMember oldMember)
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- 引数oldMemberに指定された子要素を,このシナリオ要素の子要素のリストから削除します。
- 引数:
- oldMember - 削除する子要素を表すXBRLDimensionMemberオブジェクトを指定します。
- 戻り値:
- 削除された子要素を表すXBRLDimensionMemberオブジェクトを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数oldMemberにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数oldMemberに指定した子要素が,このシナリオ要素の子要素でない場合にスローされます。[エラーコード:22104]
(11) hasExplicitMember
public boolean hasExplicitMember(XBRLQName dimension)
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素に,該当する<xbrldi:explicitMember>要素が存在するかどうかを調べます。
- 引数:
- dimension - 検索する<xbrldi:explicitMember>要素のdimension属性の値を指定します。
- 戻り値:
- このシナリオ要素の子要素に,該当する<xbrldi:explicitMember>要素が存在する場合はtrue,存在しない場合はfalseを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数dimensionにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数dimensionに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,このXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
- 引数dimensionに指定されたXBRLQNameオブジェクトが名前空間に属していなく,かつ,このXBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
(12) hasExplicitMember
public boolean hasExplicitMember(XBRLQName dimension,
XBRLQName value)
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素に,該当する<xbrldi:explicitMember>要素が存在するかどうかを調べます。
- 引数:
- dimension - 検索する<xbrldi:explicitMember>要素のdimension属性の値を指定します。
- value - 検索する<xbrldi:explicitMember>要素の内容を指定します。
- 戻り値:
- このシナリオ要素の子要素に,該当する<xbrldi:explicitMember>要素が存在する場合はtrue,存在しない場合はfalseを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数dimensionまたは引数valueに,nullを指定した場合にスローされます。[エラーコード:20002]
- 引数dimensionまたは引数valueに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,このXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
- 引数dimensionまたは引数valueに指定したXBRLQNameオブジェクトが名前空間に属さないで,かつ,このXBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]
(13) hasTypedMember
public boolean hasTypedMember(XBRLQName dimension)
- XBRLのバージョン:
- 2.1
- XBRL Dimensionsのバージョン:
- 1.0
- 説明:
- シナリオ要素の子要素に,該当する<xbrldi:typedMember>要素が存在するかどうかを調べます。
- 引数:
- dimension - 検索する<xbrldi:typedMember>要素のdimension属性の値を指定します。
- 戻り値:
- このシナリオ要素の子要素に,該当する<xbrldi:typedMember>要素が存在する場合はtrue,存在しない場合はfalseを返します。
- 例外:
- XBRLDOMRuntimeException -
- 操作対象のインスタンス文書が準拠しているXBRLのバージョンが2.1でない場合にスローされます。[エラーコード:20100]
- 操作対象のインスタンス文書が準拠しているXBRL Dimensionsのバージョンが1.0でない場合にスローされます。[エラーコード:22100]
- 引数dimensionにnullを指定した場合にスローされます。[エラーコード:20002]
- 引数dimensionに指定したXBRLQNameオブジェクトの名前空間URIに対応する名前空間宣言が,このXBRLInstanceDocumentオブジェクトに登録されていない場合にスローされます。[エラーコード:20023]
- 引数dimensionに指定したXBRLQNameオブジェクトが名前空間に属さないで,かつ,このXBRLInstanceDocumentオブジェクトにデフォルトの名前空間の宣言が登録されている場合にスローされます。[エラーコード:20069]