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

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

Ens.Settings

abstract class Ens.Settings

Method Inventory (Including Private)

Parameters

parameter SETTINGS;
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Methods

method AssignOneSetting(pProperty As %String, pValue As %String, pName As %String) as %Status
classmethod EnumerateSettingsClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateSettingsExecute(ByRef qHandle As %Binary) as %Status
classmethod EnumerateSettingsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
private classmethod GetDynamicSettingRow(pSettingName As %String = "", pSourceClass As %String = "") as %List
Helper method to get the data for setting pSettingName in pSourceClass that dynamically looks the data up in ^oddCOM. This method should only be invoked when GetSettingRow()() recognises that it hasn't been regenerated in pSourceClass.
private classmethod GetSettingRow(pSettingName As %String = "", pSourceClass As %String = "") as %List
Generated helper method to get the data for setting pSettingName in pSourceClass without referencing ^oddCOM. For backwards compatibility reasons, the code will fall back on calling GetDynamicSettingRow()() to perform a lookup in ^oddCOM if the specific subclass hasn't yet had the method regenerated.
classmethod GetSettings(Output pSettings) as %String

Queries

query EnumerateSettings()
Selects Name, Description, Type, Default, MAXLEN, MINVAL, MAXVAL, VALUELIST, DISPLAYLIST, IsRequired, LocalizedName, Category, LocalizedCategory, EditorContext

Subclasses

Feedback