IPM
IConfigurable Class Reference

Interface for classes that require some level of configuration. More...

Inheritance diagram for IConfigurable:
Inheritance graph

Static Public Member Functions

_.Library.Status ClearSettingValue (_.Library.String pName)
 Clears value of setting pName
 
_.Library.String GetSettingType (_.Library.String pName)
 Returns the datatype of a setting, as one of: More...
 
_.Library.String GetSettingValue (_.Library.String pName)
 Clears value of setting pName
 
_.Library.Status SetSettingValue (_.Library.String pName, _.Library.String pValue)
 Sets setting pName to pValue. More...
 
_.Library.Boolean SettingIsDefined (_.Library.String pName)
 Returns true if a value is defined for setting pName.
 

Static Public Attributes

 DESCRIPTION = None
 Interface for classes that require some level of configuration. More...
 
 SETTINGS = None
 A delimited string in the format: More...
 

Detailed Description

Interface for classes that require some level of configuration.

SETTINGS and DESCRIPTION are used to dynamically populate IPM.Extension.ServerMenu.Configuration with all classes that implement IConfigurable.

Member Function Documentation

◆ GetSettingType()

_.Library.String GetSettingType ( _.Library.String  pName)
static

Returns the datatype of a setting, as one of:

boolean, string The default implementation is to always return "string"

Reimplemented in AbstractSettings.

◆ SetSettingValue()

_.Library.Status SetSettingValue ( _.Library.String  pName,
_.Library.String  pValue 
)
static

Sets setting pName to pValue.

Should return an error Status if pValue is invalid.

Reimplemented in AbstractSettings.

Member Data Documentation

◆ DESCRIPTION

DESCRIPTION = None
static

Interface for classes that require some level of configuration.

SETTINGS and DESCRIPTION are used to dynamically populate IPM.Extension.ServerMenu.Configuration with all classes that implement IConfigurable.

A string to show in the grouping of settings for this class

◆ SETTINGS

SETTINGS = None
static

A delimited string in the format:

Key:Description[|Key:Description...]