6.6.22 XBRLPeriodインターフェース

public interface XBRLPeriod
extends XBRLInstanceNode

XBRLのバージョン:
2.0および2.1
説明:
時期要素を表します。
フィールドの概要:
XBRLPeriodインターフェースのフィールドの概要を次の表に示します。

表6-53 XBRLPeriodインターフェースのフィールドの概要

項番説明
1static intINSTANT
  この時期要素の内容の意味は「ある特定の時点」です。
2static intFOREVER
  この時期要素の内容の意味は「永遠」です。
3static intSTARTDATE_DURATION
  この時期要素の内容の意味は「開始日,継続期間」です。
4static intDURATION_ENDDATE
  この時期要素の内容の意味は「継続期間,終了日」です。
5static intSTARTDATE_ENDDATE
  この時期要素の内容の意味は「開始日,終了日」です。
メソッドの概要:
XBRLPeriodインターフェースのメソッドの概要を次の表に示します。

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

項番説明XBRLのバージョン
1intgetPeriodType()
  時期要素の内容の意味を取得します。
2.0および2.1
2XBRLDateUniongetInstant()
  時期要素の内容のある特定の時点を取得します。
2.0および2.1
3XBRLDateUniongetStartDate()
  時期要素の内容の開始日を取得します。
2.0および2.1
4XBRLDateUniongetEndDate()
  時期要素の内容の終了日を取得します。
2.0および2.1
5XBRLDurationgetDuration()
  時期要素の内容の継続期間を取得します。
2.0
<この項の構成>
(1) getPeriodType
(2) getInstant
(3) getStartDate
(4) getEndDate
(5) getDuration

(1) getPeriodType

public int getPeriodType()

XBRLのバージョン:
2.0および2.1
説明:
時期要素の内容の意味を取得します。
このメソッドが返す値は,XBRLのバージョンによって異なります。利用できる時期要素の内容の意味とXBRLのバージョンの関係を次の表に示します。

表6-55 利用できる時期要素の内容の意味とXBRLのバージョンの関係

項番時期要素の内容の意味XBRL2.0XBRL2.1
1INSTANT
2FOREVER
3STARTDATE_DURATION×
4DURATION_ENDDATE×
5STARTDATE_ENDDATE

(凡例)○:利用できます。 ×:利用できません。


戻り値:
この時期要素の内容の意味を返します。

(2) getInstant

public XBRLDateUnion getInstant()

XBRLのバージョン:
2.0および2.1
説明:
時期要素の内容のある特定の時点を取得します。
このメソッドは,この時期要素の内容の意味がINSTANTの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この時期要素の内容の意味は,getPeriodType()を呼び出して調べることができます。
戻り値:
この時期要素の内容のある特定の時点を返します。
例外:
XBRLDOMRuntimeException -
  • この時期要素の内容の意味がINSTANTでない場合にスローされます。[エラーコード:20030]

(3) getStartDate

public XBRLDateUnion getStartDate()

XBRLのバージョン:
2.0および2.1
説明:
時期要素の内容の開始日を取得します。
このメソッドは,この時期要素の内容の意味がSTARTDATE_DURATIONまたはSTARTDATE_ENDDATEの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この時期要素の内容の意味は,getPeriodType()を呼び出して調べることができます。
戻り値:
この時期要素の内容の開始日を返します。
例外:
XBRLDOMRuntimeException -
  • この時期要素の内容の意味がSTARTDATE_DURATIONまたはSTARTDATE_ENDDATEのどちらでもない場合にスローされます。[エラーコード:20030]

(4) getEndDate

public XBRLDateUnion getEndDate()

XBRLのバージョン:
2.0および2.1
説明:
時期要素の内容の終了日を取得します。
このメソッドは,この時期要素の内容の意味がDURATION_ENDDATEまたはSTARTDATE_ENDDATEの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この時期要素の内容の意味は,getPeriodType()を呼び出して調べることができます。
戻り値:
この時期要素の内容の終了日を返します。
例外:
XBRLDOMRuntimeException -
  • この時期要素の内容の意味がDURATION_ENDDATEまたはSTARTDATE_ENDDATEのどちらでもない場合にスローされます。[エラーコード:20030]

(5) getDuration

public XBRLDuration getDuration()

XBRLのバージョン:
2.0
説明:
時期要素の内容の継続期間を取得します。
このメソッドは,この時期要素の内容の意味がSTARTDATE_DURATIONまたはDURATION_ENDDATEの場合に呼び出せます。それ以外の場合に呼び出した場合は,XBRLDOMRuntimeException例外がスローされます。この時期要素の内容の意味は,getPeriodType()を呼び出して調べることができます。
戻り値:
この時期要素の内容の継続期間を返します。
例外:
XBRLDOMRuntimeException -
  • この時期要素の内容の意味がSTARTDATE_DURATIONまたはDURATION_ENDDATEのどちらでもない場合にスローされます。[エラーコード:20030]