6.7.17 XBRLIllegalCycleExceptionクラス

public class XBRLIllegalCycleException extends XBRLDOMException

XBRLのバージョン:
2.1
説明:
関係ネットワークに対するサイクル検証で検出されたエラーを通知するために,uCosminexus Business Reporting Processorによって生成されます。
この例外クラスは,エラーコードが15104または15105の場合に使用されます。
メソッドの概要:
XBRLIllegalCycleExceptionクラスのメソッドの概要を次の表に示します。

表6-85 XBRLIllegalCycleExceptionクラスのメソッドの概要

項番説明XBRLのバージョン
1java.lang.StringgetLinkName()
  エラーが検出された関係ネットワークを定義している拡張リンクの種類を取得します。
2.1
2java.lang.StringgetExtendedLinkRole()
  エラーが検出された関係ネットワークを定義している拡張リンクのロールを取得します。
2.1
3java.lang.StringgetArcrole()
  エラーが検出された関係ネットワークを定義しているアークのアークロールを取得します。
2.1
4java.lang.StringgetCyclesAllowed()
  エラーが検出された関係ネットワークで許可されるサイクルの種類を取得します。
2.1
5XBRLRelationship[]getErrorRoutes()
  誤っていた経路を取得します。
2.1
6XBRLRelationship[]getRelationRoutes()
  誤っていた経路に関連するもう一つの経路を取得します。
2.1
<この項の構成>
(1) getLinkName
(2) getExtendedLinkRole
(3) getArcrole
(4) getCyclesAllowed
(5) getErrorRoutes
(6) getRelationRoutes

(1) getLinkName

public java.lang.String getLinkName()

XBRLのバージョン:
2.1
説明:
エラーが検出された関係ネットワークを定義している拡張リンクの種類を取得します。
このメソッドが返す文字列は,拡張リンクを記述しているextended型要素のローカル名となります。例えば,エラーが検出された関係のネットワークがプレゼンテーションリンクによって定義されているものである場合,プレゼンテーションリンクを記述するextended型要素はlink:presentationLink要素であるため,このメソッドが返す文字列はpresentationLinkとなります。
戻り値:
エラーが検出された関係ネットワークを定義している拡張リンクの種類を返します。

(2) getExtendedLinkRole

public java.lang.String getExtendedLinkRole()

XBRLのバージョン:
2.1
説明:
エラーが検出された関係ネットワークを定義している拡張リンクのロールを取得します。
戻り値:
エラーが検出された関係ネットワークを定義している拡張リンクのロールを返します。

(3) getArcrole

public java.lang.String getArcrole()

XBRLのバージョン:
2.1
説明:
エラーが検出された関係ネットワークを定義しているアークのアークロールを取得します。
戻り値:
エラーが検出された関係ネットワークを定義しているアークのアークロールを返します。

(4) getCyclesAllowed

public java.lang.String getCyclesAllowed()

XBRLのバージョン:
2.1
説明:
エラーが検出された関係ネットワークで許可されるサイクルの種類を取得します。
このメソッドにはundirectedまたはnoneのどちらかの文字列が返ります。サイクルの種類については,「2.3.2(6) 関係ネットワーク上のサイクルの検証【完全な妥当性検証の場合だけ有効】」を参照してください。
戻り値:
エラーが検出された関係ネットワークで許可されるサイクルの種類を返します。

(5) getErrorRoutes

public XBRLRelationship[] getErrorRoutes()

XBRLのバージョン:
2.1
説明:
誤っていた経路を取得します。
エラーコードが15105(経路が複数ある旨のエラー)の場合は,XBRLIllegalCycleException.getRelationRoutes()メソッドを呼び出すことによって,もう一つの経路を取得できます。
このメソッドは,誤っていた経路を構成している関係をXBRLRelationshipオブジェクトの配列として返します。この配列に格納されているXBRLRelationshipオブジェクトは,経路の始点から終点へ向かう順番で並んでいます。例を次の図に示します。

図6-15 XBRLIllegalCycleException.getErrorRoutes()メソッドが返す配列の例

[図データ]
戻り値:
誤っていた経路を示すXBRLRelationshipオブジェクトの配列を返します。

(6) getRelationRoutes

public XBRLRelationship[] getRelationRoutes()

XBRLのバージョン:
2.1
説明:
誤っていた経路に関連するもう一つの経路を取得します。
このメソッドは,エラーコードが15105(経路が複数ある旨のエラー)の場合に使用します。エラーコードが15104(経路が循環している旨のエラー)の場合,このメソッドはnullを返します。
このメソッドが返す配列に格納されているXBRLRelationshipオブジェクトは,XBRLIllegalCycleException.getErrorRoutes()メソッドと同様に,経路の始点から終点へ向かう順番で並んでいます。
戻り値:
エラーコードが15105の場合は,誤っていた経路に関連するもう一つの経路を示すXBRLRelationshipオブジェクトの配列を返します。エラーコードが15104の場合はnullを返します。