persistent class %IPM.Storage.ResourceReference
extends %Persistent, %XML.Adaptor, %IPM.Utils.ComparisonAdaptor
• parameter DEFAULTGLOBAL = "^IPM.Storage.ResourceReference";
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 NAMESPACE = "http://www.intersystems.com/PackageManager";
NAMESPACE specifies the XML namespace to be used when projecting the
class to XML. If NAMESPACE = "", the default namespace is used for the XML schema
is used as the namespace for his class.
• property Attributes
as array of %String(MAXLEN="",XMLKEYNAME="Name",XMLNAME="Attribute",XMLNIL=0,XMLPROJECTION="ELEMENT");
Additional name-value pairs related to this resource
May be referred to in lifecycle methods
• property Children
as array of %String(MAXLEN=1,XMLPROJECTION="NONE");
Array where key = name of child, value = ""
• property Deploy
as %Boolean(XMLPROJECTION="ATTRIBUTE");
If set to true, this source code is not shipped in application packaging.
(Of course, it must be included in module packaging.)
• property Generated
as %Boolean(XMLPROJECTION="ATTRIBUTE");
Specify if this resource is generated. A generated resource will not be loaded nor exported by lifecycle methods
• relationship Module
as %IPM.Storage.Module(XMLPROJECTION="NONE") [ SqlFieldName = ModuleItem,Inverse = Resources,Cardinality = parent ];
• property Name
as %String(MAXLEN=255,XMLPROJECTION="attribute") [ Required ];
• property OverrideName
as %String(MAXLEN=255,XMLPROJECTION="NONE");
Overridden unique identifier for this resource; provided by resource processor classes.
• property Preload
as %Boolean(XMLPROJECTION="ATTRIBUTE");
Specify if this resource is from reload directory
• property Processor
as %IPM.ResourceProcessor.Abstract(XMLPROJECTION="NONE") [ Transient ];
Transient instance of ProcessorClass
• property ProcessorClass
as %Dictionary.Classname(XMLPROJECTION="ATTRIBUTE");
Specifies a class that handles lifecycle events for this resource
Typically only applicable to directory/file resources
• property Scope
as %String(VALUELIST=",test,verify",XMLPROJECTION="ATTRIBUTE");
Restrict the scope in which this resource is included. Default is "all scopes"
• property UniqueName
as %String(MAXLEN=255,XMLPROJECTION="NONE") [ Calculated ];
Unique identifier for the resource.
For most typical resources (classes, include files, etc.) this is set to the resource name.
For resources starting with /, this is set to "" by default (indicating "not required to be unique").
If a resource processor class is defined, this name can be customized via the OnGetUniqueName method, and override the above behaviors (via OverrideName)
• classmethod GetChildren(pResourceName As %String, pModuleName As %String, pCheckModuleOwnership As %Boolean = 1, ByRef pResourceInfoArray, Output pResourceArray)
as %Status
helper for ResolveChildren
• method GetSortKey()
as %String
• classmethod GetStatus(InternalName As %String, Output pReferenced As %Boolean, Output pEditable As %Boolean, Output pSourceModuleName As %String, Output pMessage As %String)
as %Status
• method IsInScope(pCurrentPhase As %String = "", Output pInCurrentPhase As %Boolean = 0)
as %Boolean
Returns true if the resource is in scope for the current module lifecycle operation.
May also be used to test if the resource's scope matches the current phase.
• classmethod NonNullResourceNameExists(pResourceName As %String, Output pID As %Integer = "")
as %Boolean
For performance reasons, this should be used rather than ResourceNameExists.
• classmethod NonNullResourceNameOpen(pResourceName As %String, pConcurrency As %Integer = -1, Output pSC As %Status = $$$OK)
as %IPM.Storage.ResourceReference
For performance reasons, this should be used rather than ResourceNameOpen.
• method OverrideNameGet()
as %String
This is a Get accessor method for the OverrideName property.
• method ProcessorClassGet()
as %String
This is a Get accessor method for the ProcessorClass property.
• method ProcessorGet()
as %IPM.ResourceProcessor.Abstract
This is a Get accessor method for the Processor property.
• method ResolveChildren(ByRef pResourceArray, pCheckModuleOwnership As %Boolean = 1)
as %Status
Returns an array of resources composing this resource, with the names as subscripts of pResourceArray.
If pCheckModuleOwnership is 0 (the default is 1), for .PKG resources, all classes in the package will
be included (even if they are actually part of another module).
• method UpdateChildrenFromString(pChildren As %String)
Updates Children to the contents of pChildren.
@Argument pChildren comma delimited string of Studio document names that are contained in this resource
•index (Children on Children(KEYS));
•index (ResourceName on UniqueName) [Unique];
Name index is unique per namespace.
•trigger OnChange
(AFTER event INSERT/UPDATE)
