com.ihr.xbrl.dts.history

Interface HistoricalEventInterface

All Known Implementing Classes:

ApiHistoricalEventImpl, HistoricalEventImpl, HumanReadableHistoricalEventImpl

public interface HistoricalEventInterface

This is the interface for an historical event. It contains the event date and event message. The toString() method shall return a text representation of the event message and date.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getApiValue() This method is important when isHuman() returns false because it allows an API consumer to obtain the original object that generated the value as an Object that can be cast to the proper type.
java.util.Date	getDate() Returns the date the historical event was produced.
java.lang.String	getHTMLString() Returns an HTML representation of the message.
java.lang.String	getMessage() Return the text message for this historical event.
java.lang.String	getSourceModule() This returns a "well known" string value that is the same for the module generating the historical value for instance, the mapper processor returns "mapper" and the ixbrl processor returns "ixbrl".
java.lang.String	getToolTipText() The key information that could be used in a tool tip, can be null.
boolean	isHuman() returns true if the information stored in this event is "human readable" this means it can be easily used for creating user messages with a reference to the fact value.
java.lang.String	toString() Returns a text representation of the entire event including all the information available.

Method Detail

getMessage

java.lang.String getMessage()

Return the text message for this historical event. All other information such as the date is not returned

Returns:

text

getDate

java.util.Date getDate()

Returns the date the historical event was produced.

Returns:

jave.util.Date

getToolTipText

java.lang.String getToolTipText()

The key information that could be used in a tool tip, can be null.

Returns:

text

getHTMLString

java.lang.String getHTMLString()

Returns an HTML representation of the message. This is creating an HTML representation of the message in a single paragraph where the tool tip text is in bold (if a tool tip text is defined). Note: this method shall not return the outer html tags than the paragraph

Returns:

text in html format

toString

java.lang.String toString()

Returns a text representation of the entire event including all the information available.

Overrides:

toString in class java.lang.Object

Returns:

text

isHuman

boolean isHuman()

returns true if the information stored in this event is "human readable" this means it can be easily used for creating user messages with a reference to the fact value. This also means a call to other methods in this class can be called. If the return value is false. then it is not safe to call getMessage() or getToolTipText() as they might not even be able to compute a proper value. But it is guaranteed that a call to getApiValue will return the proper history value

Returns:

true, if is human

Since:

3.5.1 ^ 1339

getSourceModule

java.lang.String getSourceModule()

This returns a "well known" string value that is the same for the module generating the historical value for instance, the mapper processor returns "mapper" and the ixbrl processor returns "ixbrl".

Returns:

a string value

Since:

3.5.1 ^ 1339

getApiValue

java.lang.Object getApiValue()

This method is important when isHuman() returns false because it allows an API consumer to obtain the original object that generated the value as an Object that can be cast to the proper type. Use the value returned by getSourceModule() in order to cast the value.

Returns:

the api value

Since:

3.5.1 ^ 1339