IPM
Module Class Reference
Inheritance diagram for Module:
Inheritance graph

Public Member Functions

_.Library.Status ExportToXML (_.Library.String flags)
 Export this document to the current device in XML format.
 
_.Library.Status ImportFromXML (_.Library.RegisteredObject stream, _.Library.String flags)
 Import from the stream in XML format.
 
_.Library.Status Load ()
 Load the module definition <property>Name</property> into the stream <property>Code</property>
 
_.Library.Status Save ()
 Save the module definition document.
 
- Public Member Functions inherited from Abstract
_.Library.Status CompileDocument (_.Library.String qstruct)
 CompileDocument is called when the document is to be compiled. More...
 
_.Library.Status Lock (_.Library.String flags)
 Lock the current routine, default method just unlocks the ^ROUTINE global with the name of the routine. More...
 
_.Library.Status Unlock (_.Library.String flags)
 Unlock the current routine, default method just unlocks the ^ROUTINE global with the name of the routine.
 

Static Public Member Functions

_.Library.Status Delete (_.Library.String name)
 Delete the module definition name.
 
_.Library.Boolean Exists (_.Library.String name)
 Return 1 if the given document exists and 0 if it does not.
 
_.Library.String GetOther (_.Library.String Name)
 Returns a comma-separated list of individual resources listed in the module manifest. More...
 
_.Library.Status ImportStream (_.Library.String pName, _.Library.GlobalCharacterStream pStream)
 Save the module definition document from stream to database.
 
_.Library.TimeStamp TimeStamp (_.Library.String name)
 Return the timestamp of schema category 'name' in TimeStamp format, i.e. More...
 
- Static Public Member Functions inherited from Abstract
_.Library.TimeStamp CompileTime (_.Library.String name)
 Return the compile time of routine 'name' in TimeStamp format. More...
 
_.Library.Status LockName (_.Library.String name)
 Called from Library.RoutineMgr:LockItem to lock a document by name (including extension)
 
_.Library.Status OnDelete (_.Library.String name)
 Subclasses may override to take additional steps during deletion. More...
 
_.Library.Status UnlockName (_.Library.String name)
 Called from Library.RoutineMgr:UnlockItem to unlock a document by name (including extension)
 

Additional Inherited Members

- Static Public Attributes inherited from Abstract
 STREAMCLASS = None
 Optional subclass of IPM.StudioDocument.AbstractStream that stores code in a character stream.
 

Member Function Documentation

◆ GetOther()

_.Library.String GetOther ( _.Library.String  Name)
static

Returns a comma-separated list of individual resources listed in the module manifest.

This does not include packages or CSP/filesystem resources.

◆ TimeStamp()

_.Library.TimeStamp TimeStamp ( _.Library.String  name)
static

Return the timestamp of schema category 'name' in TimeStamp format, i.e.

$zdatetime($horolog,3).

This is used to determine if the category has been updated on the server and so needs reloading into Studio. So the format should be $zdatetime($horolog,3), or "" if the category does not exist.

Reimplemented from Abstract.