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

Ens.Util.LookupTableDocument

class Ens.Util.LookupTableDocument extends %Studio.AbstractDocument

Abstract Document used to load a set of LookupTable values into Studio.

Method Inventory (Including Private)

Parameters

parameter EXTENSION = .LUT;

Methods (Including Private)

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 lookup table definition name.
classmethod Exists(name As %String) as %Boolean
Return 1 if the given lookup table 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 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) as %Status
method Load() as %Status
Load the lookup table definition into the stream Code
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(name As %String) as %TimeStamp
Return the timestamp of lookup table 'name' in %TimeStamp format, i.e. $zdatetime($horolog,3). This is used to determine if the lookup table has been updated on the server and so needs reloading into Studio. So the format should be $zdatetime($horolog,3), or "" if the lookup table 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.
private classmethod getTableName(name As %String, Output pTableName As %String) as %Status

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 (Including Private)

Inherited Methods (Including Private)