class %DeepSee.Time.Year
extends %DeepSee.Time.AbstractLevel
This class implements a Year level within a time dimension.
• parameter DIMTYPE = "year";
Type reported back to the UI. This determines what type of control to display
for filters based on this class.
• classmethod %Convert(pTime As %DeepSee.Datatype.dateTime, pOffset As %String = "")
as %Integer
Convert a $H value to the logical value used for this level.
This is used within the computed field logic for properties
within a fact table based on this level.
.
In this case, we convert $H to the year number.
• classmethod %GetLevelMembers(Output pList As %List, pCube As %String, pFact As %String, pStartRange As %Date, pEndRange As %Date, pOffset As %String = "", pFormat As %String = "")
as %Status
Return an array of members of this level.
• classmethod %GetName()
as %String
Return the user-visible name of this level.
• classmethod %GetRelatedKey(Output pRelatedKey As %String, pCube As %String, pFact As %String, pKey As %String, pRelation As %String, pOffset As %Integer = "", pEndKey As %String = "", pTimeOffset As %String = "")
as %Status
Return, via pRelatedKey a key within this level
related to pKey.
• classmethod %KeyToBaseRange(pValue As %String, Output pStart As %Date, Output pEnd As %Date, pOffset As %String = "")
as %Status
Convert a year value (year number) into starting and ending
base values (in $H format).
• classmethod %KeyToValue(pKey As %Integer, pFormat As %String = "", pOffset As %String = "")
as %String
Convert a level key value to a display value.
• classmethod %SupportsNOW()
as %Boolean
Return true if this level supports a NOW member.
• classmethod %ValueToKey(pValue As %String, pFormat As %String = "", pOffset As %String = "")
as %Integer
Convert a level display value to its corresponding key value.
Return "" if there is no corresponding key.
