This class contains all the information about a configuration parameter, including the name, the current value, a description of it and a warning or constrant string.
More...
Inherits com.pcbsys.nirvana.client.Observable.
|
| bool | Equals (long aLong) |
| | Compares this object with the passed object. More...
|
| |
| override bool | Equals (object item) |
| | Compares this object with the passed object. More...
|
| |
| virtual long | getMax () |
| | Retrieves the maximum range value of the configuration parameter More...
|
| |
| virtual long | getMin () |
| | Retrieves the minimum range value of the configuration parameter More...
|
| |
| virtual fConfigObject | getParent () |
| |
| virtual int | getType () |
| | Retrieves the type of the configuration parameter More...
|
| |
| virtual string | getWarning () |
| | Returns a String which contains information about the limits/bounds of this parameter and what would be nominal values More...
|
| |
| virtual bool | isReadOnly () |
| | Returns whether the specific entry is read only and therefore cannot be modifed More...
|
| |
| virtual bool | lessThan (long aLong) |
| | Sets the parameters value to the new value passed. More...
|
| |
| virtual bool | lessThan (object item) |
| | Compares this object with the passed object. More...
|
| |
| virtual void | validateNewValue (string @value) |
| | Validates a proposed new value for the config entry. More...
|
| |
|
| virtual string | Description [get] |
| | Returns a string which contains the description for this parameter and typically what it is used for. More...
|
| |
| virtual string | Name [get] |
| | Retrieves the name of the configuration parameter More...
|
| |
| virtual string | Value [get, set] |
| | Retrieves the current value of this parameter. More...
|
| |
This class contains all the information about a configuration parameter, including the name, the current value, a description of it and a warning or constrant string.
This class extends Observable since the value can be changed asynchronously from the realm. When this happens any observer is notified of the changed value, passed as a String
| bool com.pcbsys.nirvana.nAdminAPI.nConfigEntry.Equals |
( |
long |
aLong | ) |
|
Compares this object with the passed object.
For internal use only
- Parameters
-
| aLong | long to compare against |
- Returns
- True if this object is equal to the passed long
| override bool com.pcbsys.nirvana.nAdminAPI.nConfigEntry.Equals |
( |
object |
item | ) |
|
Compares this object with the passed object.
For internal use only
- Parameters
-
| item | Object to compare against |
- Returns
- True if this object is equal to the passed object
| virtual long com.pcbsys.nirvana.nAdminAPI.nConfigEntry.getMax |
( |
| ) |
|
|
virtual |
Retrieves the maximum range value of the configuration parameter
- Returns
- maximum range value of config object
| virtual long com.pcbsys.nirvana.nAdminAPI.nConfigEntry.getMin |
( |
| ) |
|
|
virtual |
Retrieves the minimum range value of the configuration parameter
- Returns
- minumum range value of config object
| virtual fConfigObject com.pcbsys.nirvana.nAdminAPI.nConfigEntry.getParent |
( |
| ) |
|
|
virtual |
- Returns
- The parent object that contains this entry;
| virtual int com.pcbsys.nirvana.nAdminAPI.nConfigEntry.getType |
( |
| ) |
|
|
virtual |
Retrieves the type of the configuration parameter
- Returns
- type of config object
| virtual string com.pcbsys.nirvana.nAdminAPI.nConfigEntry.getWarning |
( |
| ) |
|
|
virtual |
Returns a String which contains information about the limits/bounds of this parameter and what would be nominal values
- Returns
- a warning for this config entry as a String
| virtual bool com.pcbsys.nirvana.nAdminAPI.nConfigEntry.isReadOnly |
( |
| ) |
|
|
virtual |
Returns whether the specific entry is read only and therefore cannot be modifed
- Returns
- if the entry is read only
| virtual bool com.pcbsys.nirvana.nAdminAPI.nConfigEntry.lessThan |
( |
long |
aLong | ) |
|
|
virtual |
Sets the parameters value to the new value passed.
This value is nit committed to the realm until the nRealmNode.commitConfig(nConfigGroup) is called.
- Parameters
-
| value | The new value to set this parameter to as a String |
- Exceptions
-
nRealmNode nConfigGroup
Compares this object with the passed object. For internal use only
- Parameters
-
| aLong | long to compare against |
- Returns
- True if this object is less than the passed long
| virtual bool com.pcbsys.nirvana.nAdminAPI.nConfigEntry.lessThan |
( |
object |
item | ) |
|
|
virtual |
Compares this object with the passed object.
For internal use only
- Parameters
-
| item | Object to compare against |
- Returns
- True if this object is less than the passed object
| virtual void com.pcbsys.nirvana.nAdminAPI.nConfigEntry.validateNewValue |
( |
string @ |
value | ) |
|
|
virtual |
Validates a proposed new value for the config entry.
- Parameters
-
| value | a string object specifying the value to be validated |
- Exceptions
-
| virtual string com.pcbsys.nirvana.nAdminAPI.nConfigEntry.Description |
|
get |
Returns a string which contains the description for this parameter and typically what it is used for.
- Returns
- a description for this config entry as a String
| virtual string com.pcbsys.nirvana.nAdminAPI.nConfigEntry.Name |
|
get |
Retrieves the name of the configuration parameter
- Returns
- the name of this configuration parameter as a String
| virtual string com.pcbsys.nirvana.nAdminAPI.nConfigEntry.Value |
|
getset |
Retrieves the current value of this parameter.
The parameter is always a string though it could represent longs/ints/booleans etc
- Returns
- the current value of this configuration parameter as a String
