Home > Class Reference > %SYS namespace > %ZHSLIB.PackageManager.Developer.Processor.FileCopy

%ZHSLIB.PackageManager.Developer.Processor.FileCopy

class %ZHSLIB.PackageManager.Developer.Processor.FileCopy extends %ZHSLIB.PackageManager.Developer.Processor.Abstract

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter ATTRIBUTES = InstallDirectory,Overlay,CSPApplication,SourceDirectory,Defer;
Comma-separated list of resource attribute names that this processor uses
parameter DESCRIPTION = Copies the specified directory or file (the resource name) to a specific target location (InstallDirectory) during the Activate phase.;
Description of resource processor class (shown in UI)

Properties (Including Private)

property CSPApplication as %String);
Optional hint to source control class: which CSP application path do these files map to? For use cases where the CSPApplication resource processor is too heavy-handed - e.g., /csp/xslt Of course, this is only relevant for files that need to be copied to a CSP application. Note that this may be a full CSP file path, not only the name of a CSP application.
Property methods: CSPApplicationDisplayToLogical(), CSPApplicationGet(), CSPApplicationIsValid(), CSPApplicationLogicalToDisplay(), CSPApplicationLogicalToOdbc(), CSPApplicationNormalize(), CSPApplicationSet()
property Defer as %Boolean [ InitialExpression = 0 ];
If true, the files will be copied at the end of the Activate phase rather than at the beginning. The default is to copy the files at the beginning of the Activate phase. Use this for build artifacts.
Property methods: DeferDisplayToLogical(), DeferGet(), DeferIsValid(), DeferLogicalToDisplay(), DeferNormalize(), DeferSet()
property InstallDirectory as %String) [ Required ];
Path to which the directory or file (a full filename, in that case) should be copied upon installation; may contain expressions.
Property methods: InstallDirectoryDisplayToLogical(), InstallDirectoryGet(), InstallDirectoryIsValid(), InstallDirectoryLogicalToDisplay(), InstallDirectoryLogicalToOdbc(), InstallDirectoryNormalize(), InstallDirectorySet()
property Overlay as %Boolean;
If true, the files should be added to the target location (rather than fully replacing it, causing other files there to be deleted) Relevant for directories only.
Property methods: OverlayDisplayToLogical(), OverlayGet(), OverlayIsValid(), OverlayLogicalToDisplay(), OverlayNormalize(), OverlaySet()
property SourceDirectory as %String);
(Absolute) directory/filename to copy; if specified, overrides module root and resource name as source.
Property methods: SourceDirectoryDisplayToLogical(), SourceDirectoryGet(), SourceDirectoryIsValid(), SourceDirectoryLogicalToDisplay(), SourceDirectoryLogicalToOdbc(), SourceDirectoryNormalize(), SourceDirectorySet()

Methods (Including Private)

private method %OnNew(pResourceReference As %ZHSLIB.PackageManager.Developer.ResourceReference) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

method GetSourceControlInfo(Output pInfo As %ZHSLIB.PackageManager.Developer.Extension.SourceControl.ResourceInfo) as %Status [ Language = objectscript ]
classmethod NormalizePath(pPath As %String) as %String [ Language = objectscript ]
Adds a trailing slash if there is no extension.
method OnActivate(ByRef pParams) as %Status [ Language = objectscript ]
method OnAfterPhase(pPhase As %String, ByRef pParams) as %Status [ Language = objectscript ]
method OnBeforeArtifact(pExportDirectory As %String, pWorkingDirectory As %String, ByRef pParams) as %Status [ Language = objectscript ]
method OnBeforePhase(pPhase As %String, ByRef pParams) as %Status [ Language = objectscript ]
method OnGetUniqueName(Output pUniqueName) [ Language = objectscript ]
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)
method OnResolveChildren(ByRef pResourceArray, pCheckModuleOwnership As %Boolean = 1) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window