Skip to main content

%DeepSee.Time.MonthYear

Class %DeepSee.Time.MonthYear Extends %DeepSee.Time.AbstractLevel [ System = 3 ]

This class implements a Month level within a time dimension. This represents a specific month within a specific year.

Parameters​

DIMTYPE​

Parameter DIMTYPE = "month";

Methods​

%Convert​

ClassMethod %Convert(pTime As %DeepSee.Datatype.dateTime, pTimeOffset As %String = "") As %Integer [ CodeMode = expression ]

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 a logical year+month number: That is, Year+Month in the form YYYYMM

%GetName​

ClassMethod %GetName() As %String

Return the user-visible name of this level.

%KeyToValue​

ClassMethod %KeyToValue(pKey As %Integer, pFormat As %String = "", pTimeOffset As %String = "") As %String

Convert a level key value to a display value.

%ValueToKey​

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.

%KeyToBaseRange​

ClassMethod %KeyToBaseRange(pKey As %String, Output pStart As %Date, Output pEnd As %Date, pOffset As %String = "") As %Status

Convert a month-year value (month-year number) into starting and ending base values (in $H format).

%GetLevelMembers​

ClassMethod %GetLevelMembers(Output pList As %List, pCube As %String, pFact As %String, pStartRange As %Date, pEndRange As %Date, pTimeOffset As %String = "", pFormat As %String = "") As %Status

Return an array of members of this level.

%GetRelatedKey​

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.

%SupportsNOW​

ClassMethod %SupportsNOW() As %Boolean

Return true if this level supports a NOW member.