This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


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)


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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)