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
- CompileTime()
- Delete()
- Exists()
- ExportToXML()
- ImportFromXML()
- ImportStream()
- IsMapped()
- ListClose()
- ListExecute()
- ListFetch()
- Load()
- LocalizeDescription()
- Lock()
- LockName()
- Save()
- TimeStamp()
- Unlock()
- UnlockName()
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.
Delete the Default Settings.
Return 1 if time is defined for the class (e.g. Ens.Config.DefaultSettings).
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.
Return true if this is mapped from a database other than the default routine database and zero otherwise.
Also set the source database in sourcedb.
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
Lock the current document.
If it fails then return a status code of the error, otherise return $$$OK
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.
Unlock the current document.
Unlock a document by name.
Queries
Inherited Members
Inherited Properties
- %Location
- AtEnd
- Attributes
- Code
- CompileTime
- Generated
- Id
- LastModified
- LineTerminator
- Locked
- Name
- Size
- TimeStamp
- UpToDate
Inherited Methods
- %AddToSaveSet()
- %CheckUnique()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LOBPrefetch()
- %LocationSet()
- %LockStream()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %ObjectSize()
- %Oid()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %RollBack()
- %Save()
- %SerializeObject()
- %SetModified()
- %UnlockStream()
- %ValidateObject()
- AtEndGet()
- AtEndSet()
- Clear()
- Compile()
- CompileDocument()
- CompileTimeGet()
- CopyFrom()
- CopyFromAndSave()
- DeleteAttribute()
- DeleteStream()
- FindAt()
- Flush()
- GetAttribute()
- GetAttributeList()
- GetOther()
- GetPrevious()
- GetStreamId()
- InputFromDevice()
- IsCharacter()
- IsDefinedAttribute()
- IsEnabled()
- IsGenerated()
- IsMappedGlobal()
- IsNull()
- IsUpToDate()
- ItemList()
- LastModifiedGet()
- LineTerminatorSet()
- MoveTo()
- MoveToEnd()
- NextAttribute()
- OpenStream()
- OutputToDevice()
- OutputToDeviceAt()
- Read()
- ReadLine()
- ReadLineIntoStream()
- ReadSQL()
- Rewind()
- SaveAs()
- SaveStream()
- Search()
- SearchRegex()
- SerializeToSyncSet()
- SetAttribute()
- SetAttributeList()
- SizeGet()
- StreamOIDIsNull()
- SyncStreamIn()
- TimeStampGet()
- TranslateExportName()
- UpToDateGet()
- Write()
- WriteLine()