IPM
ModuleTemplate Class Reference
Inheritance diagram for ModuleTemplate:
Inheritance graph

Public Member Functions

_.Library.Status AddDependant (_.Library.String pDependant)
 add dependancy
 
_.Library.Status AddWebApps (_.Library.String pApps, _.Library.List cspapps, curns)
 adds a web application to the temporary array of module resources
 
_.Library.Status ReadGlobals (_.Library.String pSearchString)
 pSearchString - a mask, or comma-separated list of masks, to select globals
 
- Public Member Functions inherited from Module
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
_.Library.Boolean CompareWithRelationships (_.IPM.Storage.Module pModuleObj, _.Library.List pIgnorePropertyList, _.Library.List pDifferingPropertyArray)
 Calls <method>CompareTo</method> on this object and also calls it on any relationships in the class. More...
 
_.Library.Status GetResolvedReferences (pReferenceArray, _.Library.Boolean pLockedDependencies, _.Library.List pPhases, _.Library.Boolean pSkipDependencies, pDependencyGraph)
 Builds a module's immediate dependency graph and array of resources. More...
 
_.Library.Status GetStudioProject (_.Studio.Project pProject, _.Library.Boolean pDeployedCode, _.Library.Boolean pDefaultDeployedValue, _.Library.String pProjectSuffix)
 By default (first byref argument only), creates a Studio project containing all of the module's resources. More...
 

Static Public Member Functions

 Expfilename (code, wd)
 test.dfi -> /dfi/test.dfi More...
 
 ExportOneResource (workdir, flags, mask, ignoremask)
 Export different types of modules in different subfolders in UDL (plain) format. More...
 
_.Library.Status ExportResources (_.Library.String Path, _.Library.String ExportList)
 Export Resources. More...
 
_.Library.Status GenerateTemplate (_.Library.String pPath)
 creates a module.xml file with fictional data
 
_.Library.Status GetCSPApplications (_.Library.List pApplications, currentNamespace)
 returns list of non-system csp applications in the current namespace
 
- Static Public Member Functions inherited from Module
_.Library.Status ExecutePhases (_.Library.String pModuleName, _.Library.List pPhases, _.Library.Boolean pIsComplete, pParams)
 Execute multiple lifecycle phases in sequence. More...
 
_.Library.List GetKnownDependencies (_.Library.String pModuleName)
 This method builds a list of any direct/indirect dependencies of the module named pModuleName in a breadth-first manner.
 
_.Library.Status Uninstall (_.Library.String pModuleName, _.Library.Boolean pForce, _.Library.Boolean pRecurse, pParams)
 Uninstalls a named module (pModuleName). More...
 
_.Library.Status ValidateStream (_.Stream.Object pManifest, _.IPM.Storage.QualifiedModuleInfo pModuleReference, _.IPM.Storage.Module pModule)
 Validates the module manifest in pManifest - both that it can be interpreted properly as XML, and also that the module it contains (returned in pModule) has. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
- 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

 ModuleFolder
   More...
 
 TemplateResources
   More...
 
- Public Attributes inherited from Module
 AfterInstallMessage
   More...
 
 Author
   More...
 
 AvailabilityClass
 Defined class which can report that a module is not available for this instance/namespace. More...
 
 CalculatedResources
 Calculated property used for XML output of Resources relationship (in a reasonable order: More...
 
 Defaults
 Default settings - there may be serveral types of these (subclasses of ModuleSetting). More...
 
 Dependencies
   More...
 
 Deployed
   More...
 
 Description
   More...
 
 DeveloperMode
 Set to 1 if this module is in development mode, 0 if it is not. More...
 
 ExternalName
   More...
 
 GlobalScope
   More...
 
 Hash
   More...
 
 InstallerClass
   More...
 
 Invokes
   More...
 
 Keywords
   More...
 
 LastModifiedTimestamp
   More...
 
 Lifecycle
   More...
 
 LifecycleClass
 Lifecycle class used by default for this module. More...
 
 Mappings
   More...
 
 OverrideLifecycleClass
 Lifecycle class to use for a specific command (may be overridden from command line) More...
 
 Packaging
 Typically "module" or "application", but intentionally not enforced with VALUELIST. More...
 
 Resources
   More...
 
 Root
 Root directory on the filesystem from which this module was loaded. More...
 
 SourcesRoot
 Sources root, where placed any source code. More...
 
 SystemRequirements
   More...
 
 Version
 Does not need comparison method to be code generated because that comparing <property>VersionString</property> is good enough. More...
 
 VersionString
   More...
 
- Public Attributes inherited from ModuleInfo
 AllVersions
   More...
 
 Deployed
   More...
 
 Description
   More...
 
 DisplayName
 Case-sensitive display name of the module as it appears in the module manifest. More...
 
 Name
 lowercase storage name of the module More...
 
 Origin
   More...
 
 PlatformVersion
 Version of IRIS for Deployed modules. More...
 
 Repository
 The repository from which this module was loaded. More...
 
 Version
   More...
 
 VersionString
   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

◆ Expfilename()

Expfilename (   code,
  wd 
)
static

test.dfi -> /dfi/test.dfi

test.cls -> /cls/test.cls testpkg.test.cls -> /cls/testpkg/test.cls

◆ ExportOneResource()

ExportOneResource (   workdir,
  flags,
  mask,
  ignoremask 
)
static

Export different types of modules in different subfolders in UDL (plain) format.

test.dfi -> /dfi/test.dfi testpkg.test.cls -> /cls/testpkg/test.cls Fork from https://github.com/intersystems-ru/cache-udl d ##class(IPM.Storage.ModuleTemplate).ExportOneResource("d:\_proj\app","00000","apptools.","apptools.M") byte=1 isGenerated byte=2 isSystem byte=3 isPercented byte=4 isMapped byte=5 isDFI

◆ ExportResources()

_.Library.Status ExportResources ( _.Library.String  Path,
_.Library.String  ExportList 
)
static

Export Resources.

Example: ExportList="00000,apptools.,apptools.M^00000,apptools.,apptools.M"

Member Data Documentation

◆ ModuleFolder

ModuleFolder

 

 

◆ TemplateResources

TemplateResources