stream class %IPM.StudioDocument.Module
extends %IPM.StudioDocument.Abstract
• parameter EXTENSION = ".ZPM";
• parameter INFOGLOBAL = "^IPM.StuDoc.Module";
• parameter STREAMCLASS = "%IPM.StudioDocument.ModuleStream";
Optional subclass of %IPM.StudioDocument.AbstractStream that stores code in a character stream.
• classmethod Delete(name As %String)
as %Status
Delete the module definition name.
• classmethod Exists(name As %String)
as %Boolean
Return 1 if the given document exists and 0 if it does not.
• method ExportToXML(flags As %String)
as %Status
Export this document to the current device in XML format
• classmethod GetOther(Name As %String)
as %String
Returns a comma-separated list of *individual* resources listed in the module manifest.
This does not include packages or CSP/filesystem resources.
• method ImportFromXML(stream As %RegisteredObject, flags As %String)
as %Status
Import from the stream in XML format
• classmethod ImportStream(pName As %String, pStream As %GlobalCharacterStream)
as %Status
Save the module definition document from stream to database.
• method Load()
as %Status
Load the module definition Name into the stream Code
• method OnCompileDocument(ByRef qstruct As %String)
as %Status
• method Save()
as %Status
Save the module definition document.
• classmethod TimeStamp(name As %String)
as %TimeStamp
[ SQLProc = ]
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.
• classmethod UpdatePersistentFromStream(pStream As %IPM.StudioDocument.ModuleStream, Output pModule As %IPM.Storage.Module)
as %Status
• query ItemList()
Selects
name As %String, modified As %TimeStamp
SQL Query
:
select Name, LastModifiedTimestamp from %IPM_StudioDocument.ModuleStream
union
select Name, LastModifiedTimestamp from %IPM_Storage.ModuleItem
where Name not in (select Name from %IPM_StudioDocument.ModuleStream)
Subclasses must override
Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.
