This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > Ens.Util.SettingsDocument

Ens.Util.SettingsDocument

class Ens.Util.SettingsDocument extends %Studio.AbstractDocument

Used to load deployable settings documents into Studio. See Ens.Config.DefaultSettings for one use.

Method Inventory

Parameters

parameter EXTENSION = .ESD;

Methods

classmethod CompileTime(pName As %String) as %TimeStamp
Return the compile time of routine 'pName' in %TimeStamp format. The format should be $zdatetime($horolog,3), or "" if the routine does not exist.
classmethod Delete(pName As %String) as %Status
Delete the Default Settings.
classmethod Exists(pName As %String) as %Boolean
Return 1 if time is defined for the class (e.g. Ens.Config.DefaultSettings).
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 lookup table 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 = "") 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 Deployable Default Settings into the stream Code irrespective of ProductionName set
classmethod LocalizeDescription(ext As %String, ByRef Description As %String(MAXLEN=500)) as %Status
method Lock(flags As %String) as %Status
Lock the current document. If it fails then return a status code of the error, otherise return $$$OK
classmethod LockName(name As %String) as %Status
Lock a document by name.
method Save() as %Status
Save the lookup table definition document.
classmethod TimeStamp(pName As %String) as %TimeStamp
Return the timestamp of text document 'pName' in %TimeStamp format, i.e. $zdatetime($horolog,3). This is used to determine if the document 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 document.
classmethod UnlockName(name As %String) as %Status
Unlock a document by name.

Queries

query List(Directory As %String, Flat As %Boolean, System As %Boolean)
Selects name As %String, modified As %TimeStamp, size As %Integer, directory As %String

Inherited Members

Inherited Properties

Inherited Methods