Package org.netxms.client.server
Class ServerVariable
java.lang.Object
org.netxms.client.server.ServerVariable
Server's configuration variable.
-
Constructor Summary
ConstructorDescriptionServerVariable
(String name, String value, boolean isServerRestartNeeded, ServerVariableDataType dataType, String description, String unit) Default constructor for NXCServerVariable.ServerVariable
(NXCPMessage msg, long baseId) Create variable from NXCP message -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPossibleValue
(NXCPMessage msg, long baseId) Add possible value to variable from NXCP messageGet default value prepared for display.getName()
getUnit()
getValue()
boolean
Get variable value as booleanint
Get variable value as integerGet variable's value for display.protected String
getValueForDisplay
(String value) Get variable's value for display.boolean
boolean
-
Constructor Details
-
ServerVariable
public ServerVariable(String name, String value, boolean isServerRestartNeeded, ServerVariableDataType dataType, String description, String unit) Default constructor for NXCServerVariable.- Parameters:
name
- Variable's namevalue
- Variable's valueisServerRestartNeeded
- Server restart flag (server has to be restarted after variable change if this flag is set)dataType
- Data type for server configuration variabledescription
- Descriptionunit
- Unit- See Also:
-
ServerVariable
Create variable from NXCP message- Parameters:
msg
- NXCP messagebaseId
- base object id
-
-
Method Details
-
addPossibleValue
Add possible value to variable from NXCP message- Parameters:
msg
- NXCP MessagebaseId
- value base id
-
getName
- Returns:
- Varaible's name
-
getValueForDisplay
Get variable's value for display. Will replace numeric value with textual description when possible.- Parameters:
value
- to convert to display form- Returns:
- Variable's value prepared for display
-
getValueForDisplay
Get variable's value for display. Will replace numeric value with textual description when possible.- Returns:
- Variable's value prepared for display
-
getValue
- Returns:
- Variable's value
-
getValueAsBoolean
public boolean getValueAsBoolean()Get variable value as boolean- Returns:
- value as boolean
-
getValueAsInt
public int getValueAsInt()Get variable value as integer- Returns:
- value as integer
-
getDataType
- Returns:
- Variable`s data type
-
getDescription
- Returns:
- Variable`s description
-
isServerRestartNeeded
public boolean isServerRestartNeeded()- Returns:
- Server restart flag
-
getPossibleValues
- Returns:
- A list of possible variable values
-
getDefaultValue
- Returns:
- Variable`s default value
-
getDefaultValueForDisplay
Get default value prepared for display.- Returns:
- Variable`s default value prepared for display
-
isDefault
public boolean isDefault()- Returns:
- true if variable`s value is the default value
-
getUnit
- Returns:
- get variable unit
-