%IPM.ResourceProcessor.Abstract
abstract class %IPM.ResourceProcessor.Abstract extends %Library.RegisteredObject
Superclass for all classes used to process lifecycle events for resourcesProperty Inventory
Method Inventory
- ApplyDefaults()
- GetAttributeMetadata()
- GetDescription()
- GetSourceControlInfo()
- OnAfterPhase()
- OnBeforeArtifact()
- OnBeforePhase()
- OnExportItem()
- OnGetStudioProject()
- OnGetUniqueName()
- OnItemRelativePath()
- OnPhase()
- OnResolveChildren()
- SatisfiesCondition()
- SetParams()
Parameters
parameter ATTRIBUTES;
Comma-separated list of resource attribute names that this processor uses
parameter DESCRIPTION;
Description of resource processor class (shown in UI)
parameter NAME;
Properties
property Params [ MultiDimensional ];
Property methods: ParamsDisplayToLogical(), ParamsGet(), ParamsIsValid(), ParamsLogicalToDisplay(), ParamsLogicalToOdbc(), ParamsNormalize(), ParamsSet()
Methods
method ApplyDefaults()
classmethod GetAttributeMetadata(Output pMetaArray) as %Status
Projected as the stored procedure: Abstract_GetDescription
method GetSourceControlInfo(Output pInfo As %IPM.ExtensionBase.SourceControl.ResourceInfo) as %Status
method OnBeforeArtifact(pExportDirectory As %String, pWorkingDirectory As %String, ByRef pParams) as %Status
method OnExportItem(pFullExportPath As %String, pItemName As %String, ByRef pItemParams, ByRef pParams, Output pItemHandled As %Boolean = 0) as %Status
method OnGetStudioProject(pProject As %Studio.Project, Output pHandled As %Boolean = 0)
Subclasses may override to customize the studio project. (e.g., things that use web applications will do this.)
method OnGetUniqueName(Output pUniqueName)
Returns a unique name for this resource.
Default implementation, leaving pUniqueName undefined, reverts to default behavior.
An empty string indicates guaranteed uniqueness (useful for folders relative to module root)
Returns the path relative to the module root for item pItemName within this resource.
method OnPhase(pPhase As %String, ByRef pParams, Output pResourceHandled As %Boolean = 0) as %Status
Called as phase pPhase is executed for the resource. If pResourceHandled is set to true,
then the default behavior for that resource will be bypassed in the current phase.
Currently, this is only used in the Verify phase, because of different handling of intermediate error statuses.
TODO: Implement for standard database resources (.INC, .CLS, etc.)
method SatisfiesCondition(pCondition As %IPM.Storage.ModuleSetting.ProcessorDefault.Condition) as %Boolean
method SetParams(ByRef pParams) as %Status
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()