abstract persistent class %IPM.General.AbstractSettings
extends %Persistent, %IPM.General.Singleton, %IPM.General.IConfigurable
Intended use case:
If you want a configuration-related class of which there will be at most one instance, that has settings with names defined in code
(not just magic strings, and possibly with default values) that are configurable via the "init" command in the Package Manager shell
and the Package Manager > Configuration menu item, extend AbstractSettings and add some properties, and you get all that.
The description of the settings is taken from the triple-slash documentation for them.
• parameter SETTINGS = "..GetSettingsParameterValue()";
A delimited string in the format:
Key:Description[|Key:Description...]
• property Key
as %String [ InitialExpression = "Settings",ReadOnly ];
• classmethod ClearSettingValue(pName As %String)
as %Status
Clears value of setting pName
• classmethod GetSettingType(pName As %String)
as %String
Returns the datatype of a setting, as one of:
boolean, string
The default implementation is to always return "string"
• classmethod GetSettingValue(pName As %String)
as %String
Clears value of setting pName
• classmethod GetSettingsParameterValue()
as %String
Returns a list of all properties available as "settings" (for IConfigurable),
along with their triple-slash comments as descriptions.
Omits calculated, multidimensional, transient, and read-only properties.
• classmethod SetSettingValue(pName As %String, pValue As %String)
as %Status
Sets setting pName to pValue. Should return an error %Status if pValue is invalid.
• classmethod SettingIsDefined(pName As %String)
as %Boolean
Returns true if a value is defined for setting pName.
•index (Key on Key) [IdKey,Unique];
