Abstract Class Reference

Superclass for all classes used to process lifecycle events for resources. More...

Inheritance diagram for Abstract:

Public Member Functions
	OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled)
	Subclasses may override to customize the studio project. More...
	OnGetUniqueName (pUniqueName)
	Returns a unique name for this resource. More...
_.Library.String	OnItemRelativePath (_.Library.String pItemName)
	Returns the path relative to the module root for item pItemName within this resource.
_.Library.Status	OnPhase (_.Library.String pPhase, pParams, _.Library.Boolean pResourceHandled)
	Called as phase pPhase is executed for the resource. More...

Public Attributes
	Params
	More...

Static Public Attributes
	ATTRIBUTES = None
	Comma-separated list of resource attribute names that this processor uses.
	DESCRIPTION = None
	Description of resource processor class (shown in UI)

Private Member Functions
	__CopyDefaultAttributes (_.IPM.Storage.ModuleSetting.ProcessorDefault pSource)
	Generated similarly to <method>CopyAttributes</method>

Private Attributes
	__ResourceReference
	More...

Detailed Description

Superclass for all classes used to process lifecycle events for resources.

Member Function Documentation

OnGetStudioProject()

OnGetStudioProject	(	_.Studio.Project	pProject,
		_.Library.Boolean	pHandled
	)

Subclasses may override to customize the studio project.

(e.g., things that use web applications will do this.)

Reimplemented in CSPApplication.

OnGetUniqueName()

OnGetUniqueName

(

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)

Reimplemented in Document, DeepSeeItem, WebApplication, Test, CSPApplication, and Copy.

OnPhase()

_.Library.Status OnPhase	(	_.Library.String	pPhase,
			pParams,
		_.Library.Boolean	pResourceHandled
	)

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

Reimplemented in LocalizedMessages, Global, Document, DeepSeeItem, WebApplication, Test, FileCopy, and Copy.

Member Data Documentation

Params

Params

 

 

__ResourceReference

__ResourceReference

private