AbstractInstaller Class Reference

Abstract base class that defines the interface for product-level Installer.Install classes. More...

Static Public Member Functions
_.Library.Status	OnComponentMaintenanceVersion (_.Library.String pMinorVersion)
	Callback to return the minor version of the component. More...
_.Library.Status	OnComponentVersion (_.Library.Integer pMajorVersion)
	Callback to return the major version of the component. More...
_.Library.Status	OnConfigureComponent (_.Library.String pNamespace, _.Library.Boolean pVerbose, pVars)
_.Library.Status	OnInstallComponent (_.Library.String pDatabase, _.Library.Boolean pVerbose, _.Library.Boolean pDevMode, _.Library.Boolean pIsUpgrade)
	Callback that is invoked during product installation to allow for. More...
_.Library.Status	OnUnInstallComponent (_.Library.String pDatabase, _.Library.Boolean pVerbose)
	Callback that is invoked when removing a product.
_.Library.Status	OnUnconfigureComponent (_.Library.String pNamespace, _.Library.Boolean pVerbose, _.Library.Boolean pPurgeFiles, pVars)
	Callback that is invoked when removing a product from a namespace. More...
_.Library.Status	OnUpgradeSteps (_.Library.String pPreviousVersion)
	What to do system wide (not specific namespaces) during an upgrade. More...

Detailed Description

Abstract base class that defines the interface for product-level Installer.Install classes.

Member Function Documentation

OnComponentMaintenanceVersion()

_.Library.Status OnComponentMaintenanceVersion ( _.Library.String  pMinorVersion )

static

Callback to return the minor version of the component.

This implementation uses the <parameter>MaintenanceVersion</parameter>,

which must by implemented by the installer subclass (or else the subclass must override this method using some other approach). If not overridden, and the Version parameter is not populated, this method will throw an exception (not merely return an error status). pMinorVersion is generally set to the value of a product-level macro which defines the minor version, e.g. $$$HSLIBminorVersion for PackageManager Core.

OnComponentVersion()

_.Library.Status OnComponentVersion ( _.Library.Integer  pMajorVersion )

static

Callback to return the major version of the component.

This implementation uses the <parameter>Version</parameter>,

which must by implemented by the installer subclass (or else the subclass must override this method using some other approach). If not overridden, and the Version parameter is not populated, this method will throw an exception (not merely return an error status). pMajorVersion is generally set to the value of a product-level macro which defines the major version, e.g. $$$HSLIBmajorVersion for PackageManager Core.

OnConfigureComponent()

_.Library.Status OnConfigureComponent ( _.Library.String  pNamespace, _.Library.Boolean  pVerbose,   pVars  )

static

Callback that is invoked during namespace (re)activation.

Subclasses SHOULD override this method.

pVars is an array of miscellaneous information, populated by the calling code in the installation/configuration framework (mainly <class>HS.Util.Installer</class>). Subscripts appearing in pVars include:

• Production - set to (namespace)_"PKG.FoundationProduction"
• LogFile - current log file for install operation
• Upgrade - boolean, indicating whether the current operation is an upgrade
• Type - hardcoded to "Foundation"
• Component - current component name

OnInstallComponent()

_.Library.Status OnInstallComponent ( _.Library.String  pDatabase, _.Library.Boolean  pVerbose, _.Library.Boolean  pDevMode, _.Library.Boolean  pIsUpgrade  )

static

Callback that is invoked during product installation to allow for.

system-level changes to be performed. Common examples of such changes include:

• Definition of resources and roles
• Definition/configuration of the product library database
• Import of localized messages for the product

Subclasses SHOULD override this method.

OnUnconfigureComponent()

_.Library.Status OnUnconfigureComponent ( _.Library.String  pNamespace, _.Library.Boolean  pVerbose, _.Library.Boolean  pPurgeFiles,   pVars  )

static

Callback that is invoked when removing a product from a namespace.

Subclasses SHOULD override this method.

OnUpgradeSteps()

_.Library.Status OnUpgradeSteps ( _.Library.String  pPreviousVersion )

static

What to do system wide (not specific namespaces) during an upgrade.

Not currently called by the framework, but present for future use.