IRISLIB database
Utils Class Reference

Utility container for the management of cube versions. More...

Inheritance diagram for Utils:
Collaboration diagram for Utils:

Static Private Member Functions

_.Library.Status DeprecateCubeVersion (_.Library.String pCubeGenericName, _.Library.Integer pVersion)
 Mark a cube version as deprecated. More...
 
_.Library.Integer GetActiveCubeVersion (_.Library.String pCubeGenericName)
 Return the active version number for pCubeGenericName
 
_.Library.String GetCubeVersionStatus (_.Library.String pCubeGenericName, _.Library.Integer pVersion)
 Return the current promotion status of version pVersion the cube pCubeGenericName.
 
_.Library.Status GetDeprecatedVersionList (_.Library.String pCubeGenericName, pList)
 Given the generic name of a versioned cube, collect the list of deprecated versions currently on the system.
 
_.Library.String GetGenericCubeName (_.Library.String pCubeVersionName, _.Library.Status pSC)
 If a cube has different versions, get the reference name given a version name pCubeName. More...
 
_.Library.String GetPendingCubeVersion (_.Library.String pCubeGenericName)
 Return the pending version number for pCubeGenericName. More...
 
_.Library.String GetVersionedCubeName (_.Library.String pCubeGenericName, _.Library.Integer pVersion, _.Library.Status pSC)
 If a cube has different versions, get the name of the version currently active given the reference name pCubeGenericName. More...
 
_.Library.Boolean IsActiveVersion (_.Library.String pCubeVersionName)
 Test whether the current cube pCubeVersionName is the active version.
 
_.Library.Boolean IsDeprecatedVersion (_.Library.String pCubeVersionName)
 Test whether the current cube pCubeVersionName is deprecated.
 
_.Library.Boolean IsPendingVersion (_.Library.String pCubeVersionName)
 Test whether the current cube pCubeVersionName is the pending version.
 
_.Library.Boolean IsVersion (_.Library.String pCubeName, pCubeGenericName, pVersion)
 It is valid to manually write a cube logical name that can look like a version when it is not. More...
 
_.Library.Status RemoveCubeVersion (_.Library.String pCubeGenericName, _.Library.Integer pVersion)
 Completely remove all components of a cube version from the system. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

Utility container for the management of cube versions.

Member Function Documentation

◆ DeprecateCubeVersion()

_.Library.Status DeprecateCubeVersion ( _.Library.String  pCubeGenericName,
_.Library.Integer  pVersion 
)
staticprivate

Mark a cube version as deprecated.

Once deprecated, a version is ready for removal.

◆ GetGenericCubeName()

_.Library.String GetGenericCubeName ( _.Library.String  pCubeVersionName,
_.Library.Status  pSC 
)
staticprivate

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.

◆ GetPendingCubeVersion()

_.Library.String GetPendingCubeVersion ( _.Library.String  pCubeGenericName)
staticprivate

Return the pending version number for pCubeGenericName.

An empty string indicates there is no pending version.

◆ GetVersionedCubeName()

_.Library.String GetVersionedCubeName ( _.Library.String  pCubeGenericName,
_.Library.Integer  pVersion,
_.Library.Status  pSC 
)
staticprivate

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.

◆ IsVersion()

_.Library.Boolean IsVersion ( _.Library.String  pCubeName,
  pCubeGenericName,
  pVersion 
)
staticprivate

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 = ""

◆ RemoveCubeVersion()

_.Library.Status RemoveCubeVersion ( _.Library.String  pCubeGenericName,
_.Library.Integer  pVersion 
)
staticprivate

Completely remove all components of a cube version from the system.

This cannot be performed on a cube version marked "active".