persistent class %IPM.Storage.Module
extends %Persistent, %IPM.General.ModuleInfo, %IPM.Utils.ComparisonAdaptor
SQL Table Name: ModuleItem
• parameter DEFAULTGLOBAL = "^IPM.Storage.Module";
If a persistent class uses %Storage.Persistent then the DEFAULTGLOBAL parameter is used as the
default global root for the values of the storage keywords COUNTERLOCATION, DATALOCATION, IDLOCATION,
INDEXLOCATION and STREAMLOCATION in the active storage definition. DEFAULTGLOBAL is only used
to generate location keyword values that are not already defined. The location value is constructed by adding
a location type to the end of DEFAULTGLOBAL. For example, if DEFAULTGLOBAL = "^GL.Account"
the compiler will generate DATALOCATION = ^GL.AccountD.
If USEEXTENTSET is true, then DEFAULTGLOBAL is used as the default extent location.
The location types are:
| Location | Type |
|---|
| COUNTERLOCATION | C |
| DATALOCATION | D |
| IDLOCATION | D |
| INDEXLOCATION | I |
| STREAMLOCATION | S |
• parameter DOMAIN = "ZPM";
• property AfterInstallMessage
as %String(MAXLEN="",XMLPROJECTION="Element");
• property Author
as %IPM.Storage.ModuleAuthorInfo;
• property AvailabilityClass
as %Dictionary.Classname;
Defined class which can report that a module is not available for this instance/namespace
• property CalculatedResources
as list of %IPM.Storage.ResourceReference(XMLIO="OUT",XMLITEMNAME="Resource",XMLNAME="Resources",XMLPROJECTION="WRAPPED",XMLREFERENCE="COMPLETE") [ Calculated ];
Calculated property used for XML output of Resources relationship (in a reasonable order:
packages, classes, includes, globals, routines, CSP resources, then in alphabetical order within those categories).
• property Defaults
as list of %IPM.Storage.ModuleSetting(CLASSNAME=1,STORAGEDEFAULT="array",XMLNAME="Defaults",XMLPROJECTION="WRAPPED",XMLREFERENCE="COMPLETE",XMLTYPECONSTRAINT="SUBSTITUTIONGROUP");
Default settings - there may be serveral types of these (subclasses of ModuleSetting).
• property Dependencies
as list of %IPM.Storage.ModuleReference(STORAGEDEFAULT="array");
• property Deployed
as %Boolean(XMLPROJECTION="Element");
• property Description
as %String(MAXLEN="");
• property DeveloperMode
as %Boolean(ForceCodeGenerate=0,XMLPROJECTION="NONE");
Set to 1 if this module is in development mode, 0 if it is not.
• property ExternalName
as %String(MAXLEN=255);
• property GlobalScope
as %Boolean;
• property Hash
as %Binary(ForceCodeGenerate=0,XMLPROJECTION="NONE");
• property InstallerClass
as %Dictionary.Classname;
• relationship Invokes
as %IPM.Storage.InvokeReference(XMLITEMNAME="Invoke",XMLPROJECTION="WRAPPED",XMLREFERENCE="COMPLETE") [ Inverse = Module,Cardinality = children ];
• property Keywords
as %String(MAXLEN="");
• property LastModifiedTimestamp
as %TimeStamp(ForceCodeGenerate=0,XMLPROJECTION="NONE") [ InitialExpression = $ZDateTime($Horolog,3) ];
• property Lifecycle
as %IPM.Lifecycle.Base(XMLPROJECTION="NONE") [ Transient ];
• property LifecycleClass
as %Dictionary.Classname [ InitialExpression = "%IPM.Lifecycle.Module" ];
Lifecycle class used by default for this module
• relationship Mappings
as %IPM.Storage.MappingReference(XMLITEMNAME="Mapping",XMLPROJECTION="WRAPPED",XMLREFERENCE="COMPLETE") [ Inverse = Module,Cardinality = children ];
• property OverrideLifecycleClass
as %Dictionary.Classname [ Transient ];
Lifecycle class to use for a specific command (may be overridden from command line)
• property Packaging
as %String [ Required ];
Typically "module" or "application", but intentionally not enforced with VALUELIST.
• relationship Resources
as %IPM.Storage.ResourceReference(XMLIO="IN",XMLITEMNAME="Resource",XMLPROJECTION="WRAPPED",XMLREFERENCE="COMPLETE") [ Inverse = Module,Cardinality = children ];
• property Root
as %String(ForceCodeGenerate=0,MAXLEN="",XMLPROJECTION="NONE");
Root directory on the filesystem from which this module was loaded.
• property SourcesRoot
as %String(MAXLEN=20);
Sources root, where placed any source code
• property SystemRequirements
as %IPM.Storage.SystemRequirements(ForceCodeGenerate=0);
• property Version
as %IPM.General.SemanticVersion(ForceCodeGenerate=0,XMLPROJECTION="NONE") [ Required ];
Does not need comparison method to be code generated because that comparing VersionString is good enough.
• property VersionString
as %String(MAXLEN=100,XMLNAME="Version") [ InitialExpression = "0.0.1+snapshot",Required ];
• method %Compile(ByRef qstruct As %String)
as %Status
• method BuildDependencyGraph(ByRef pDependencyGraph, pDepth As %Integer = 1, pForceSnapshotReload As %Boolean = 0, ByRef qstruct, pPhases As %String = "", ByRef pSubModules, pPass As %Integer = 1, pModulePath As %List = $ListBuild(..Name), pIgnoreInstalledModules As %Boolean = 0, pKnownDependencies As %List = ..GetKnownDependencies(..Name), pPermitDowngrade As %Boolean = 0, pCheckNestedScoped As %Boolean = 0, ByRef pSearchList, pIncludeDisplayName As %Boolean = 0)
as %Status
• method CalculatedResourcesGet()
as %Collection.AbstractListOfObj
This is a Get accessor method for the CalculatedResources property.
• classmethod CheckSystemRequirements(pModuleName As %String)
as %Status
• method CompareWithRelationships(pModuleObj As %IPM.Storage.Module, pIgnorePropertyList As %Library.List = "", Output pDifferingPropertyArray As %Library.List)
as %Boolean
Calls %CompareTo on this object and also calls it on any relationships in the class
specifically Mappings and Resources.
• classmethod ExecutePhases(pModuleName As %String, pPhases As %List, pIsComplete As %Boolean = 0, ByRef pParams)
as %Status
Execute multiple lifecycle phases in sequence. Execution is terminated if one fails.
Example: $ListBuild("Clean","Test") or $ListBuild("Test","Install")
@API.Method
• method GetDefaultParameters(Output pParams)
• classmethod GetKnownDependencies(pModuleName As %String)
as %List
This method builds a list of any direct/indirect dependencies of the module named pModuleName in a breadth-first manner.
• method GetNamespaceConfig(ByRef pCheckedModules)
as %IPM.Storage.ModuleSetting.NamespaceConfig
• method GetResolvedReferences(Output pReferenceArray, pLockedDependencies As %Boolean = 0, pPhases As %List = "", pSkipDependencies As %Boolean = 0, ByRef pDependencyGraph)
as %Status
Builds a module's immediate dependency graph and array of resources.
Optionally loads uninstalled dependency modules and recurses over each module in the dependency graph.
@Argument pReferenceArray Array of all module's resources (including resources that compose a resource) that contain the appropriate phase scope.
@Argument pLockedDependencies Whether method should be recursively applied to the module's dependencies (true = yes).
@Argument pPhases List of IPM lifecycle phases to be applied to the current module.
@Argument pSkipDependencies Whether to skip loading uninstalled dependency modules.
@Argument pDependencyGraph Tree of module's dependencies.
• method GetStudioProject(Output pProject As %Studio.Project, pDeployedCode As %Boolean = "", pDefaultDeployedValue As %Boolean = "", pProjectSuffix As %String = "")
as %Status
By default (first byref argument only), creates a Studio project containing all of the module's resources.
If pDeployedCode is non-empty, only includes code that should be deployed (if true) or not deployed (if false).
pDefaultDeployedValue specifies the default behavior for resources with the Deploy attribute left null.
pProjectSuffix is appended to the project name (which defaults to the module name, with periods replaced by underscores).
The project suffix may be used (for example) to distinguish between projects for deployed and undeployed code.
• method HaveToDeploy()
as %Boolean
• method IsLocked()
as %Boolean
• method LifecycleGet()
as %IPM.Lifecycle.Base
This is a Get accessor method for the Lifecycle property.
• method LoadDependencies(pPhaseList As %List, ByRef pParams)
as %Status
• method Lock()
as %Status
• method OverrideLifecycleClassSet(pValue As %Dictionary.Classname)
as %Status
This is a Set accessor method for the OverrideLifecycleClass property.
• classmethod Uninstall(pModuleName As %String, pForce As %Boolean = 0, pRecurse As %Boolean = 0, ByRef pParams)
as %Status
Uninstalls a named module (pModuleName).
May optionally force installation (uninstalling even if required by other modules) if pForce is 1.
May optionally recurse to also uninstall dependencies that are not required by other modules if pRecurse is 1.
If both pForce and pRecurse are 1, then dependencies will also be uninstalled forcibly.
@API.Method
• classmethod ValidateStream(pManifest As %Stream.Object, pModuleReference As %IPM.Storage.QualifiedModuleInfo, Output pModule As %IPM.Storage.Module)
as %Status
Validates the module manifest in pManifest - both that it can be interpreted properly as XML, and also that the module it contains (returned in pModule) has
a name and version matching the supplied pModuleReference.
• method WriteAfterInstallMessage()
• classmethod XMLNew(document As %XML.Document, node As %Integer, containerOref As %RegisteredObject = "")
as %RegisteredObject
Get an instance of an XML enabled class.
You may override this method to do custom processing (such as initializing
the object instance) before returning an instance of this class.
However, this method should not be called directly from user code.
Arguments:
document is the document with %XML.Node or macros in %xmlDOM.inc.
nodeId is a node id of the node which defines this object.
An %XML.Node object may be obtained for this node using document.GetNode(nodeId)
containerOref is the containing object instance when called from XMLImport and
is "" when called from %XML.Reader for Correlate'd objects.
• query VersionRequirements(pOfModuleName As %String, pExcludeModuleNames As %List = "")
SQL Query
:
select distinct %exact Dependencies_VersionString As Version,%DLIST(ModuleItem->Name) As ModuleNames
from %IPM_Storage.ModuleItem_Dependencies
where Dependencies_Name = :pOfModuleName and
(:pExcludeModuleNames is null or ModuleItem->Name not %INLIST :pExcludeModuleNames)
group by Dependencies_VersionString
•index (Name on Name) [Unique];
