Inheritance diagram for ResourceReference:

Public Member Functions
_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Boolean	IsInScope (_.Library.String pCurrentPhase, _.Library.Boolean pInCurrentPhase)
	Returns true if the resource is in scope for the current module lifecycle operation. More...

_.Library.Status	ResolveChildren (pResourceArray, _.Library.Boolean pCheckModuleOwnership)
	Returns an array of resources composing this resource, with the names as subscripts of pResourceArray. More...

	UpdateChildrenFromString (_.Library.String pChildren)
	Updates <property>Children</property> to the contents of pChildren. More...

Static Public Member Functions
_.Library.Status	GetChildren (_.Library.String pResourceName, _.Library.String pModuleName, _.Library.Boolean pCheckModuleOwnership, pResourceInfoArray, pResourceArray)
	helper for <method>ResolveChildren</method>

_.Library.Boolean	NonNullResourceNameExists (_.Library.String pResourceName, _.Library.Integer pID)
	For performance reasons, this should be used rather than <method>ResourceNameExists</method>.

_.IPM.Storage.ResourceReference	NonNullResourceNameOpen (_.Library.String pResourceName, _.Library.Integer pConcurrency, _.Library.Status pSC)
	For performance reasons, this should be used rather than <method>ResourceNameOpen</method>.

Static Public Member Functions inherited from ComparisonAdaptor
_.Library.Boolean	CompareToSkipCondition (_.Dictionary.CompiledProperty pCompiledProperty)
	Condition under which a given property is skipped when generating code for the. More...

_.Library.List	FindAllSuperClasses (_.Dictionary.Classname pClassname)
	Returns a list of all super classes for a given class pClassname

_.Library.List	IgnoreKeywordList ()
	Returns a list of keywords such that, if a property contains any of these,. More...

Public Attributes
	Attributes
	Additional name-value pairs related to this resource. More...

	Children
	Array where key = name of child, value = "". More...

	Deploy
	If set to true, this source code is not shipped in application packaging. More...

	Generated
	Specify if this resource is generated. More...

	Module
	More...

	Name
	More...

	OverrideName
	Overridden unique identifier for this resource; provided by resource processor classes. More...

	Preload
	Specify if this resource is from reload directory. More...

	Processor
	Transient instance of ProcessorClass. More...

	ProcessorClass
	Specifies a class that handles lifecycle events for this resource. More...

	Scope
	Restrict the scope in which this resource is included. More...

	UniqueName
	Unique identifier for the resource. More...

Additional Inherited Members
Static Public Attributes inherited from ComparisonAdaptor
	SkipCodeGeneration = None
	Handles code generation of a grab bag of useful functions to be code generated, such as the following: More...

Member Function Documentation

◆ OnBeforeSave()

_.Library.Status OnBeforeSave ( _.Library.Boolean insert )

This callback method is invoked by the <METHOD>Save</METHOD> method to.

provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to <METHOD>Save</METHOD> will fail.

◆ IsInScope()

_.Library.Boolean IsInScope	(	_.Library.String	pCurrentPhase,
		_.Library.Boolean	pInCurrentPhase
	)

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.

◆ ResolveChildren()

_.Library.Status ResolveChildren	(		pResourceArray,
		_.Library.Boolean	pCheckModuleOwnership
	)

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).

◆ UpdateChildrenFromString()

UpdateChildrenFromString ( _.Library.String pChildren )

Updates <property>Children</property> to the contents of pChildren.

@Argument pChildren comma delimited string of Studio document names that are contained in this resource

Member Data Documentation

◆ Attributes

Attributes

Additional name-value pairs related to this resource.

May be referred to in lifecycle methods

◆ Children

Children

Array where key = name of child, value = "".

◆ Deploy

Deploy

If set to true, this source code is not shipped in application packaging.

(Of course, it must be included in module packaging.)

◆ Generated

Generated

Specify if this resource is generated.

A generated resource will not be loaded nor exported by lifecycle methods

◆ Module

Module

◆ Name

Name

◆ OverrideName

OverrideName

Overridden unique identifier for this resource; provided by resource processor classes.

◆ Preload

Preload

Specify if this resource is from reload directory.

◆ Processor

Processor

Transient instance of ProcessorClass.

◆ ProcessorClass

ProcessorClass

Specifies a class that handles lifecycle events for this resource.

Typically only applicable to directory/file resources

◆ Scope

Scope

Restrict the scope in which this resource is included.

Default is "all scopes"

◆ UniqueName

UniqueName

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 <property>OverrideName</property>)

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members