%ZHSLIB.PackageManager.Developer.Lifecycle.Base

abstract class %ZHSLIB.PackageManager.Developer.Lifecycle.Base extends %ZHSLIB.PackageManager.Developer.Lifecycle.Abstract

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEPLOYBYDEFAULT = 0;
parameter EXPORTDEPENDENCIES = 0;
parameter PACKAGING;
parameter PHASES;
Inherited description: $ListBuild list of phases in this lifecycle.
For each phase name, an instance method named "%" must be defined in the class with a return type of %Status.

Properties (Including Private)

property HasDeployedResources as %Boolean [ InitialExpression = 0 ];
Property methods: HasDeployedResourcesDisplayToLogical(), HasDeployedResourcesGet(), HasDeployedResourcesIsValid(), HasDeployedResourcesLogicalToDisplay(), HasDeployedResourcesNormalize(), HasDeployedResourcesSet()
property Payload as %Stream.Object [ Private ];
Property methods: PayloadDelete(), PayloadGet(), PayloadGetObject(), PayloadGetObjectId(), PayloadGetSwizzled(), PayloadIsValid(), PayloadNewObject(), PayloadOid(), PayloadOpen(), PayloadSet(), PayloadSetObject(), PayloadSetObjectId(), PayloadUnSwizzle()

Methods (Including Private)

method %Activate(ByRef pParams) as %Status [ Language = objectscript ]
method %Clean(ByRef pParams) as %Status [ Language = objectscript ]
method %Compile(ByRef pParams) as %Status [ Language = objectscript ]
method %Configure(ByRef pParams) as %Status [ Language = objectscript ]
method %Document(ByRef pParams) as %Status [ Language = objectscript ]
method %Export(ByRef pParams, ByRef pTargetDirectory As %String, Output pDependencyGraph) as %Status [ Language = objectscript ]
Note: This is a utility method, and not a full lifecycle phase at this point. This method exports the module's resources, based on the mappings defined in ^Sources (by %Reload), to the specified directory. If no directory is provided, a new temp directory is created (returned by reference). If dependencies are to be exported, pDependencyGraph is augmented with a "Location" subscript with the relative path within pTargetDirectory in which the module's contents have been exported.
method %ExportData(ByRef pParams) as %Status [ Language = objectscript ]
method %MakeDeployed(ByRef pParams) as %Status [ Language = objectscript ]
abstract method %Package(ByRef pParams) as %Status [ Language = objectscript ]
method %Publish(ByRef pParams) as %Status [ Language = objectscript ]
method %Register(ByRef pParams) as %Status [ Language = objectscript ]
method %Reload(ByRef pParams) as %Status [ Language = objectscript ]
method %Test(ByRef pParams) as %Status [ Language = objectscript ]
method %Unconfigure(ByRef pParams) as %Status [ Language = objectscript ]
method %Validate(ByRef pParams) as %Status [ Language = objectscript ]
method %Verify(ByRef pParams) as %Status [ Language = objectscript ]
method CheckBeforeClean(ByRef pParams, Output pSkip As %Boolean = 0) as %Status [ Language = objectscript ]
final classmethod GetBaseClassForPackaging(pPackaging As %String, Output pBaseClass As %Dictionary.Classname) as %Status [ Language = objectscript ]
classmethod GetCompletePhases(pPhases As %List) as %List [ Language = objectscript ]
This method defines what a complete phase means for a given list of phases
classmethod GetCompletePhasesForOne(pOnePhase As %String) as %List [ Language = objectscript ]
This method defines what a complete phase means for a given phase
method GetResourceRelativePath(pResource As %String, pExtension As %String) as %String [ Language = objectscript ]
Helper method to get the relative path to the *file* corresponding to a resource (used in %Reload/%Export). If pExtension is empty, then pResource is interpreted as having an extension. If pExtension is specified, then pResource is intrepreted as not having an extension. Note: does not support .PKG Note: does not yet support CSP/static files resources
method OnBeforeArtifact(pExportDirectory As %String, pWorkingDirectory As %String, ByRef pParams) as %Status [ Language = objectscript ]
method OnBeforeVerifyLoad(ByRef pParams) as %Status [ Language = objectscript ]
Allows for subclasses to do additional setup or modify pParams before the "verify" phase runs.
method OnDetermineResourceDeployability(ByRef pParams, ByRef pResourceInfo, Output pDeploy As %Boolean) as %Status [ Language = objectscript ]
method OnInstallFromPayload(ByRef pParams) as %Status [ Language = objectscript ]

Queries

query Packaging(pPackaging As %String = "")
SQL Query:
select cp._default as Packaging, cd.Name as BaseClass from %Dictionary.CompiledClass cd join %Dictionary.CompiledParameter cp on cp.Parent = cd.Name and cp.Name = 'PACKAGING' where cd.Name %STARTSWITH '%ZHSLIB.PackageManager.Developer.Lifecycle' -- This is a critical assumption for performance reasons. Full ^oddCOM scans are expensive! and cd.PrimarySuper [ '~%ZHSLIB.PackageManager.Developer.Lifecycle.Abstract~' and cp.Final = 1 and cp.Origin = cd.Name and (:pPackaging is null or cp._default = :pPackaging)

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

FeedbackOpens in a new window