Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.CubeVersion.Utils
Private  Storage   

%DeepSee.CubeVersion.Utils


class %DeepSee.CubeVersion.Utils extends
%RegisteredObject

Utility container for the management of cube versions

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 18


Summary


Methods
%ActivatePendingCubeVersion %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DeprecateCubeVersion %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetActiveCubeVersion %GetCubeVersionStatus
%GetDeprecatedVersionList %GetGenericCubeName %GetParameter %GetPendingCubeVersion
%GetVersionedCubeName %IsA %IsActiveVersion %IsDeprecatedVersion
%IsModified %IsPendingVersion %IsVersion %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveCubeVersion %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject


Parameters


• parameter ACTIVE = "active";
• parameter DEPRECATED = "deprecated";
• parameter PENDING = "pending";

Methods


• classmethod %ActivatePendingCubeVersion(pCubeGenericName As %String, pRemoveDeprecated As %Boolean = 1, pVerbose As %Boolean = 1) as %Status
• classmethod %DeprecateCubeVersion(pCubeGenericName As %String = "", pVersion As %Integer) as %Status
Mark a cube version as deprecated. Once deprecated, a version is ready for removal.
• classmethod %GetActiveCubeVersion(pCubeGenericName As %String) as %Integer
Return the active version number for pCubeGenericName
• classmethod %GetCubeVersionStatus(pCubeGenericName As %String, pVersion As %Integer) as %String
Return the current promotion status of version pVersion the cube pCubeGenericName.
• classmethod %GetDeprecatedVersionList(pCubeGenericName As %String = "", ByRef pList) as %Status
Given the generic name of a versioned cube, collect the list of deprecated versions currently on the system.
• classmethod %GetGenericCubeName(pCubeVersionName As %String, pSC As %Status) as %String
If a cube has different versions, get the reference name given a version name pCubeName. If the cube was not produced using cube versioning this will return the upper-case cube index.
• classmethod %GetPendingCubeVersion(pCubeGenericName As %String = "") as %String
Return the pending version number for pCubeGenericName. An empty string indicates there is no pending version.
• classmethod %GetVersionedCubeName(pCubeGenericName As %String = "", pVersion As %Integer = "", pSC As %Status) as %String
If a cube has different versions, get the name of the version currently active given the reference name pCubeGenericName. If a cube does not use cube versioning this will return the upper-case cube index.
• classmethod %IsActiveVersion(pCubeVersionName As %String) as %Boolean
Test whether the current cube pCubeVersionName is the active version.
• classmethod %IsDeprecatedVersion(pCubeVersionName As %String) as %Boolean
Test whether the current cube pCubeVersionName is deprecated.
• classmethod %IsPendingVersion(pCubeVersionName As %String) as %Boolean
Test whether the current cube pCubeVersionName is the pending version.
• classmethod %IsVersion(pCubeName As %String, Output pCubeGenericName, Output pVersion) as %Boolean
It is valid to manually write a cube logical name that can look like a version when it is not. Verify the cube name entered in pCubeName is a true version of a generic cube definition. Optionally return the decomposition of the original cube name into its genericName and version parts. If a non-versioned cube is entered as pCubeName, then:
pCubeGenericName = pCubeName pVersion = ""
• classmethod %RemoveCubeVersion(pCubeGenericName As %String = "", pVersion As %Integer) as %Status
Completely remove all components of a cube version from the system. This cannot be performed on a cube version marked "active".