com.ihr.xbrl.dts

Interface InstantOnColumnRecognitionSupport

All Known Implementing Classes:

BasicInstantOnColumnRecognition

public interface InstantOnColumnRecognitionSupport

This interface allows classes to ask how an XBRLFactItem is represented in the user interface in regard to the label role and, particularly, if the label role is at the beginning of a column period or at the end of a column period.

Author:

Ignacio

Method Summary

Modifier and Type

Method and Description

HandleDateStep.InstantMode

getInstantMode(XBRLFactItem fact, ColumnPeriod cp) This method returns a value from the InstantMode enumeration as follows: BOP if the fact is instant and the date corresponds to the beginning of the column period EOP if the fact is instant and the date corresponds to the end of the column period ANY if the fact is instant and the date is within the period but is not BOP and not EOP UNKNOWN in any other cases including the fact is duration .

Method Detail

getInstantMode

HandleDateStep.InstantMode getInstantMode(XBRLFactItem fact,
                                          ColumnPeriod cp)

This method returns a value from the InstantMode enumeration as follows:

• BOP if the fact is instant and the date corresponds to the beginning of the column period
• EOP if the fact is instant and the date corresponds to the end of the column period
• ANY if the fact is instant and the date is within the period but is not BOP and not EOP
• UNKNOWN in any other cases including the fact is duration

.

Parameters:

fact - the fact

cp - the cp

Returns:

boolean