IPM
Copy Class Reference
Inheritance diagram for Copy:
Inheritance graph

Public Member Functions

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

Public Attributes

 Overwrite
 If set to false (default is true), resources that already exist in the current/target namespace will not be overwritten. More...
 
 Source
 Name of the namespace we are copying the resources from. More...
 
- Public Attributes inherited from AbstractCompilable
 CompileAfter
 Comma-separated list of resource names after which this resource should be compiled. More...
 
 ExportFlags
 Flags/qualifiers to export items with. More...
 
 Flags
 Flags/qualifiers to compile with (overriding any more general defaults); "verbose" added per lifecycle command. More...
 
- Public Attributes inherited from Abstract
 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)
 
- Static Public Attributes inherited from AbstractCompilable
 ATTRIBUTES = None
 Comma-separated list of resource attribute names that this processor uses.
 
 DESCRIPTION = None
 Description of resource processor class (shown in UI)
 
- Static Public Attributes inherited from Abstract
 ATTRIBUTES = None
 Comma-separated list of resource attribute names that this processor uses.
 
 DESCRIPTION = None
 Description of resource processor class (shown in UI)
 

Private Attributes

 __Target
 Namespace to which the resources will be copied (managed internally) More...
 
 __TargetResourceCache
 Cache of resources discovered in the target namespace. More...
 

Member Function Documentation

◆ 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 from Abstract.

◆ 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 from Abstract.

Member Data Documentation

◆ Overwrite

Overwrite

If set to false (default is true), resources that already exist in the current/target namespace will not be overwritten.

 

◆ Source

Source

Name of the namespace we are copying the resources from.

 

◆ __Target

__Target
private

Namespace to which the resources will be copied (managed internally)

 

◆ __TargetResourceCache

__TargetResourceCache
private

Cache of resources discovered in the target namespace.