Class Reference
IRIS for UNIX 2019.4
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [Util] >  [SettingsDocument]
Private  Storage   

class Ens.Util.SettingsDocument extends %Studio.AbstractDocument

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 18 1


Summary

Properties
%Location AtEnd Attributes Code CompileTime
Generated Id LastModified LineTerminator Locked
Name Size TimeStamp UpToDate

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%CheckUnique %ClassIsLatestVersion %ClassName %Close
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DowngradeConcurrency
%Exists %ExistsId %Extends %GetParameter
%GetSwizzleObject %Id %IncrementCount %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
%UpgradeConcurrency %ValidateObject AtEndGet AtEndSet
Clear Compile CompileDocument CompileTime
CompileTimeGet CopyFrom CopyFromAndSave Delete
DeleteAttribute DeleteStream Exists ExportToXML
FindAt Flush GetAttribute GetAttributeList
GetOther GetPrevious GetStreamId ImportFromXML
ImportStream InputFromDevice IsCharacter IsDefinedAttribute
IsEnabled IsGenerated IsMapped IsNull
IsUpToDate ItemList LastModifiedGet LineTerminatorSet
ListClose ListExecute ListFetch Load
LocalizeDescription Lock LockName MoveTo
MoveToEnd NextAttribute OpenStream OutputToDevice
OutputToDeviceAt Read ReadLine ReadLineIntoStream
ReadSQL Rewind Save SaveAs
SaveStream Search SearchRegex SerializeToSyncSet
SetAttribute SetAttributeList SizeGet StreamOIDIsNull
SyncStreamIn TimeStamp TimeStampGet TranslateExportName
Unlock UnlockName UpToDateGet Write
WriteLine


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.
• private classmethod getDataTableName(name As %String, Output pDataTableName 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
This query scans over the documents for the Studio open dialog. The arguments are defined in ItemList.

This should return a row formed by:
$listbuild(name,date/time modified,size,directory delimiter)

  • name - The name to display in the open dialog
  • date/time modified - In %TimeStamp format the date/time this item was last modified
  • size - The size of this item
  • directory delimiter - If this is not a directory then return "" here, if it is a directory then return the type of delimiter to use when they double click on this directory


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.