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


class %ZHSLIB.PackageManager.Developer.Processor.Default.Document extends %ZHSLIB.PackageManager.Developer.Processor.AbstractCompilable

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter ATTRIBUTES = Compile,CompileAfter,Flags,Directory,LoadAsDirectory,FilenameExtension,FilenameTranslateIdentifier,FilenameTranslateAssociator,Format;
Comma-separated list of resource attribute names that this processor uses
parameter DESCRIPTION = Default resource processor class for %Studio.AbstractDocument subclasses;
Description of resource processor class (shown in UI)
parameter EXTENSION;
May be set to determine the value of Extension based on a static value rather than based on the resource name. The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)
parameter NAMEPOSTFIX;
When a module is loaded in developer mode, this is appended to the resource name in ^Sources - e.g., ^Sources(..Extension, _..#NAMEPOSTFIX) The only expected use case at this point is class packages (.PKG, but Extension will be .CLS)

Properties (Including Private)

property Compile as %Boolean [ InitialExpression = 1 ];
If true, the resource will be compiled during the compilation phase in the module lifecycle.
Property methods: CompileAfterDisplayToLogical(), CompileAfterGet(), CompileAfterIsValid(), CompileAfterLogicalToDisplay(), CompileAfterLogicalToOdbc(), CompileAfterNormalize(), CompileAfterSet(), CompileDisplayToLogical(), CompileGet(), CompileIsValid(), CompileLogicalToDisplay(), CompileNormalize(), CompileSet()
property Directory as %String) [ InitialExpression = $ZConvert(..#EXTENSION,"L") ];
Directory relative to module root containing the exported resource. Defaults to the resource's extension (lower-case) if unspecified.
Property methods: DirectoryDisplayToLogical(), DirectoryGet(), DirectoryIsValid(), DirectoryLogicalToDisplay(), DirectoryLogicalToOdbc(), DirectoryNormalize(), DirectorySet()
property Extension as %String [ Private ];
Extension of the server document(s) represented by this resource
Property methods: ExtensionDisplayToLogical(), ExtensionGet(), ExtensionIsValid(), ExtensionLogicalToDisplay(), ExtensionLogicalToOdbc(), ExtensionNormalize(), ExtensionSet()
property FilenameExtension as %String [ InitialExpression = "xml" ];
Extension for individual filename(s) that comprise this resource
Property methods: FilenameExtensionDisplayToLogical(), FilenameExtensionGet(), FilenameExtensionIsValid(), FilenameExtensionLogicalToDisplay(), FilenameExtensionLogicalToOdbc(), FilenameExtensionNormalize(), FilenameExtensionSet()
property FilenameTranslateAssociator as %String [ InitialExpression = "/" ];
Characters in the filename to use as the associator in $translate when determining the resource's filename on disk The default behavior is to replace "." with "/" and ignore "%"
Property methods: FilenameTranslateAssociatorDisplayToLogical(), FilenameTranslateAssociatorGet(), FilenameTranslateAssociatorIsValid(), FilenameTranslateAssociatorLogicalToDisplay(), FilenameTranslateAssociatorLogicalToOdbc(), FilenameTranslateAssociatorNormalize(), FilenameTranslateAssociatorSet()
property FilenameTranslateIdentifier as %String [ InitialExpression = ".%" ];
Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk The default behavior is to replace "." with "/" and ignore "%"
Property methods: FilenameTranslateIdentifierDisplayToLogical(), FilenameTranslateIdentifierGet(), FilenameTranslateIdentifierIsValid(), FilenameTranslateIdentifierLogicalToDisplay(), FilenameTranslateIdentifierLogicalToOdbc(), FilenameTranslateIdentifierNormalize(), FilenameTranslateIdentifierSet()
property Format as %String;
Export format - list of acceptable values may differ by subclass.
Property methods: FormatDisplayToLogical(), FormatGet(), FormatIsValid(), FormatLogicalToDisplay(), FormatLogicalToOdbc(), FormatNormalize(), FormatSet()
property LoadAsDirectory as %Boolean [ InitialExpression = 0 ];
If true (default is false), the resource is loaded as a directory.
Property methods: LoadAsDirectoryDisplayToLogical(), LoadAsDirectoryGet(), LoadAsDirectoryIsValid(), LoadAsDirectoryLogicalToDisplay(), LoadAsDirectoryNormalize(), LoadAsDirectorySet()
property Name as %String (MAXLEN = 255) [ Private ];
Name of the server document (without extension)
Property methods: NameDisplayToLogical(), NameGet(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

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 ]
method OnAfterPhase(pPhase As %String, ByRef pParams) as %Status [ Language = objectscript ]
method OnConfigureMappings(ByRef pParams) as %Status [ Language = objectscript ]
Subclasses may override to customize mapping behavior at the beginning of the Reload phase.
method OnExportItem(pFullExportPath As %String, pItemName As %String, ByRef pItemParams, ByRef pParams, Output pItemHandled As %Boolean = 0) 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 OnItemRelativePath(pItemName As %String) as %String [ Language = objectscript ]
Returns the path relative to the module root for item pItemName within this resource.
method OnLoad(pFullResourcePath As %String, pVerbose As %Boolean, pCompile As %Boolean = 0, Output pLoadedList As %String) as %Status [ Language = objectscript ]
Subclasses may override to customize resource load behavior during the Reload phase.
@Argument pFullResourcePath The absolute path to the resource present on the file system @Argument pVerbose 1: display output from loading files, 0: do not display output @Argument pCompile 1: compile files upon load, 0: do not compile files @Argument pLoadedList Output: comma delimited list of files that have been loaded
method OnPhase(pPhase As %String, ByRef pParams, Output pResourceHandled As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: 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 OnResolveChildren(ByRef pResourceArray As %Library.String, pCheckModuleOwnership As %Library.Boolean) as %Status [ Language = objectscript ]
Enumerate all documents contained in the resource being processed.
@Argument pResourceArray ByRef: array of the following format: pResourceArray() = pResourceArray(, ) = value of resource reference property for given document

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)