%DeepSee.UI.FolderItemDocument

class %DeepSee.UI.FolderItemDocument extends %Studio.AbstractDocument

Abstract Document used to load a folder item (e.g. dashboard) definition into Studio.

Method Inventory (Including Private)

Parameters

parameter EXTENSION = .DFI;

Methods

classmethod CompileTime(name As %String) as %TimeStamp [ Language = objectscript ]
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 [ Language = objectscript ]
Delete the folder item definition name.
classmethod Exists(name As %String) as %Boolean [ Language = objectscript ]
Return 1 if the given folder item document exists and 0 if it does not.
method ExportToXML(flags As %String) as %Status [ Language = objectscript ]
Export this document to the current device in XML format
method ImportFromXML(stream As %RegisteredObject, flags As %String) as %Status [ Language = objectscript ]
Import from the stream in XML format
classmethod ImportStream(pName As %String, pStream As %GlobalCharacterStream) as %Status [ Language = objectscript ]
Save the folder item definition document from stream to global.
classmethod ListClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String = "", Flat As %Boolean = "", System As %Boolean = "", pShowAll As %Boolean = 1, pFolderClass As %String = "") as %Status [ Language = objectscript ]
classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]
method Load() as %Status [ Language = objectscript ]
Load the folder item definition into the stream Code
method Save() as %Status [ Language = objectscript ]
Save the folder item definition document.
classmethod TimeStamp(name As %String) as %TimeStamp [ Language = objectscript ]
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.

Queries

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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback