IPM
DeepSeeItem Class Reference
Inheritance diagram for DeepSeeItem:
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...
 
_.Library.Status OnResolveChildren (pResourceArray)
 Enumerate all documents contained in the resource being processed. More...
 
- Public Member Functions inherited from Document
_.Library.Status OnConfigureMappings (pParams)
 Subclasses may override to customize mapping behavior at the beginning of the Reload phase.
 
_.Library.String OnItemRelativePath (_.Library.String pItemName)
 Returns the path relative to the module root for item pItemName within this resource.
 
_.Library.Status OnLoad (_.Library.String pFullResourcePath, _.Library.Boolean pVerbose, _.Library.Boolean pCompile, _.Library.String pLoadedList, _.Library.String pParams)
 Subclasses may override to customize resource load behavior during the Reload phase. More...
 
- Public Member Functions inherited from Abstract
 OnGetStudioProject (_.Studio.Project pProject, _.Library.Boolean pHandled)
 Subclasses may override to customize the studio project. More...
 

Public Attributes

 Directory
   More...
 
 FilenameExtension
   More...
 
 FilenameTranslateAssociator
 Characters in the filename to use as the associator in $translate when determining the resource's filename on disk. More...
 
 FilenameTranslateIdentifier
 Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk. More...
 
 Format
 Export format. More...
 
 Keywords
   More...
 
- Public Attributes inherited from Document
 Compile
 If true, the resource will be compiled during the compilation phase in the module lifecycle. More...
 
 Directory
 Directory relative to module root containing the exported resource. More...
 
 DirectoryDefined
   More...
 
 FilenameExtension
 Extension for individual filename(s) that comprise this resource. More...
 
 FilenameTranslateAssociator
 Characters in the filename to use as the associator in $translate when determining the resource's filename on disk. More...
 
 FilenameTranslateIdentifier
 Characters in the filename to use as the identifier in $translate when determining the resource's filename on disk. More...
 
 Format
 Export format - list of acceptable values may differ by subclass. More...
 
 LoadAsDirectory
 If true (default is false), the resource is loaded as a directory. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Document
_.Library.Boolean ResourceIsMappedToDefaultDB (_.Library.String pResourceName)
 Helper method to be used in derived classes' OnConfigureMappings() to skip creating unnecessary mappings. More...
 
- Static Public Attributes inherited from Document
 ATTRIBUTES = None
 Comma-separated list of resource attribute names that this processor uses.
 
 DESCRIPTION = None
 Description of resource processor class (shown in UI)
 
 EXTENSION = None
 May be set to determine the value of <property>Extension</property> based on a static value rather than based on the resource name. More...
 
 NAMEPOSTFIX = None
 When a module is loaded in developer mode, this is appended to the resource name in ^Sources - e.g., ^Sources(..Extension, <resource name>_..NAMEPOSTFIX) More...
 
- 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)
 

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

◆ 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 Document.

◆ OnResolveChildren()

_.Library.Status OnResolveChildren (   pResourceArray)

Enumerate all documents contained in the resource being processed.


@Argument pResourceArray ByRef: array of the following format: pResourceArray(<Studio document name>) = <module that contains document> pResourceArray(<Studio document name>, <resource referenty property>) = value of resource reference property for given document

Reimplemented from Document.

Member Data Documentation

◆ Directory

Directory

 

 

◆ FilenameExtension

FilenameExtension

 

 

◆ FilenameTranslateAssociator

FilenameTranslateAssociator

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 "%"  

◆ FilenameTranslateIdentifier

FilenameTranslateIdentifier

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 "%"  

◆ Format

Format

Export format.

 

◆ Keywords

Keywords