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...
Public Member Functions | |
| 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 | isAdvanced () |
| Retrieves if configuration parameter is advanced 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... | |
 Public Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | addObserver (IObserver o) |
| Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More... | |
| int | countObservers () |
Returns the number of observers of this Observable object. More... | |
| void | deleteObserver (IObserver o) |
| Deletes an observer from the set of observers of this object. More... | |
| void | deleteObservers () |
| Clears the observer list so that this object no longer has any observers. More... | |
| bool | hasChanged () |
| Tests if this object has changed. More... | |
| void | notifyObservers () |
If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More... | |
| void | notifyObservers (Object arg) |
| If this object has changed, as indicated by the More... | |
| Observable () | |
| Construct an Observable with zero Observers. More... | |
Properties | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable | |
| void | clearChanged () |
Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More... | |
| void | setChanged () |
Marks this Observable object as having been changed; the hasChanged method will now return true. 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
| aLong | long to compare against |
| override bool com.pcbsys.nirvana.nAdminAPI.nConfigEntry.Equals | ( | object | item | ) |
Compares this object with the passed object.
For internal use only
| item | Object to compare against |
|
virtual |
Retrieves the maximum range value of the configuration parameter
|
virtual |
Retrieves the minimum range value of the configuration parameter
|
virtual |
|
virtual |
Retrieves the type of the configuration parameter
|
virtual |
Returns a String which contains information about the limits/bounds of this parameter and what would be nominal values
|
virtual |
Retrieves if configuration parameter is advanced
|
virtual |
Returns whether the specific entry is read only and therefore cannot be modifed
|
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.
| value | The new value to set this parameter to as a String |
| nAdminIllegalArgumentException | thrown if value is null, not the correct type, or not within a specific range |
Compares this object with the passed object. For internal use only
| aLong | long to compare against |
|
virtual |
Compares this object with the passed object.
For internal use only
| item | Object to compare against |
|
virtual |
Validates a proposed new value for the config entry.
| value | a string object specifying the value to be validated |
| nAdminIllegalArgumentException | thrown if not the correct type, or not within a specific range |
|
get |
Returns a string which contains the description for this parameter and typically what it is used for.
|
get |
Retrieves the name of the configuration parameter
|
getset |
Retrieves the current value of this parameter.
The parameter is always a string though it could represent longs/ints/booleans etc