class %DeepSee.UI.FolderItemDocument
extends %Studio.AbstractDocument
Abstract Document used to load a folder item (e.g. dashboard) definition into Studio.
• parameter EXTENSION = ".DFI";
• 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
Delete the folder item definition name.
• classmethod Exists(name As %String)
as %Boolean
Return 1 if the given folder item 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
Save the folder item definition document from stream to global.
• classmethod ListClose(ByRef qHandle As %Binary)
as %Status
• classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String = "", Flat As %Boolean = "", System As %Boolean = "", pShowAll As %Boolean = 1, pFolderClass As %String = "")
as %Status
• classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0)
as %Status
• method Load()
as %Status
Load the folder item definition into the stream Code
• method Save()
as %Status
Save the folder item definition document.
• classmethod TimeStamp(name As %String)
as %TimeStamp
Return the timestamp of folder item 'name' in %TimeStamp format, i.e. $zdatetime($horolog,3).
This is used to determine if the folder item has been updated on the server and so needs reloading into Studio.
So the format should be $zdatetime($horolog,3), or "" if the folder item does not exist.
• query List(Directory As %String, Flat As %Boolean, System As %Boolean, pShowAll As %Boolean, pFolderClass As %String)
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 form by:
$listbuild(name,date/time modified,size,directory delimitor)
- 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 delimitor - If this is not an directory then return "" here, if it is a directory then
return the type of delimitor to use when they double click on this directory
