abstract stream class %IPM.StudioDocument.Abstract
extends %Studio.AbstractDocument
• parameter EXTENSION;
• parameter INFOGLOBAL;
• parameter STREAMCLASS;
Optional subclass of %IPM.StudioDocument.AbstractStream that stores code in a character stream.
• classmethod %ValidateName(name As %String)
as %Status
• method CompileDocument(ByRef qstruct As %String)
as %Status
CompileDocument is called when the document is to be compiled
It has already called the source control hooks at this point
• classmethod CompileTime(name As %String)
as %TimeStamp
Return the compile time of routine 'name' in %TimeStamp format. The format should be $zdatetime($horolog,3),
or "" if the routine does not exist.
• classmethod Delete(name As %String)
as %Status
Deletes the instance of ..#STREAMCLASS identified by 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
• 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
Saves the document in pStream to the database as an instance of ..#STREAMCLASS, with name pName
• classmethod ListClose(ByRef qHandle As %Binary)
as %Status
• classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String, Flat As %Boolean, System As %Boolean)
as %Status
• classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0)
as %Status
• method Load()
as %Status
Loads the instance of ..#STREAMCLASS identified by Name into the stream Code
• method Lock(flags As %String)
as %Status
Lock the current routine, default method just unlocks the ^ROUTINE global with the name of the routine.
If it fails then return a status code of the error, otherwise return $$$OK
• classmethod LockName(name As %String)
as %Status
Called from %Library.RoutineMgr:LockItem to lock a document by name (including extension)
• classmethod OnDelete(name As %String)
as %Status
Subclasses may override to take additional steps during deletion.
The caller handles transactions.
• 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.
• method Unlock(flags As %String)
as %Status
Unlock the current routine, default method just unlocks the ^ROUTINE global with the name of the routine
• classmethod UnlockName(name As %String)
as %Status
Called from %Library.RoutineMgr:UnlockItem to unlock a document by name (including extension)
• query ItemList()
Selects
name As %String, modified As %TimeStamp
SQL Query
:
select top 0 null,null
Subclasses must override
• query List(Directory As %String, Flat As %Boolean, System As %Boolean)
Selects
name As %String, modified As %TimeStamp, size As %Integer, directory As %String
This query scans over the documents for the Studio open dialog.
The arguments are defined in ItemList.
This should return a row formed by:
$listbuild(name,date/time modified,size,directory delimiter)
- name - The name to display in the open dialog
- date/time modified - In %TimeStamp format the date/time this item was last modified
- size - The size of this item
- directory delimiter - If this is not a directory then return "" here, if it is a directory then
return the type of delimiter to use when they double click on this directory
