6.6.22 XBRLPeriodインターフェース
public interface XBRLPeriod
extends XBRLInstanceNode
- XBRLのバージョン:
- 2.0および2.1
- 説明:
- 時期要素を表します。
- フィールドの概要:
- XBRLPeriodインターフェースのフィールドの概要を次の表に示します。
表6-53 XBRLPeriodインターフェースのフィールドの概要
項番 | 説明 |
---|
1 | static int | INSTANT この時期要素の内容の意味は「ある特定の時点」です。 |
2 | static int | FOREVER この時期要素の内容の意味は「永遠」です。 |
3 | static int | STARTDATE_DURATION この時期要素の内容の意味は「開始日,継続期間」です。 |
4 | static int | DURATION_ENDDATE この時期要素の内容の意味は「継続期間,終了日」です。 |
5 | static int | STARTDATE_ENDDATE この時期要素の内容の意味は「開始日,終了日」です。 |
- メソッドの概要:
- XBRLPeriodインターフェースのメソッドの概要を次の表に示します。
表6-54 XBRLPeriodインターフェースのメソッドの概要
- <この項の構成>
- (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.0 | XBRL2.1 |
---|
1 | INSTANT | ○ | ○ |
2 | FOREVER | ○ | ○ |
3 | STARTDATE_DURATION | ○ | × |
4 | DURATION_ENDDATE | ○ | × |
5 | STARTDATE_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]