org.netxms.client.server

Class ServerVariable

java.lang.Object

org.netxms.client.server.ServerVariable

public final class ServerVariable
extends Object

Server's configuration variable.

Constructor Summary

Constructors

Constructor and Description
ServerVariable(org.netxms.base.NXCPMessage msg, long baseId) Create variable from NXCP message
ServerVariable(String name, String value, boolean isServerRestartNeeded, ServerVariableDataType dataType, String description) Default constructor for NXCServerVariable.

Method Summary

Modifier and Type	Method and Description
void	addPossibleValue(org.netxms.base.NXCPMessage msg, long baseId) Add possible value to variable from NXCP message
ServerVariableDataType	getDataType()
String	getDefaultValue()
String	getDefaultValueForDisplay() Get default value prepared for display.
String	getDescription()
String	getName()
HashMap<String,String>	getPossibleValues()
String	getValue()
boolean	getValueAsBoolean() Get variable value as boolean
int	getValueAsInt() Get variable value as integer
String	getValueForDisplay() Get variable's value for display.
boolean	isDefault()
boolean	isServerRestartNeeded()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerVariable

public ServerVariable(String name,
                      String value,
                      boolean isServerRestartNeeded,
                      ServerVariableDataType dataType,
                      String description)

Default constructor for NXCServerVariable.

Parameters:

name - Variable's name

value - Variable's value

isServerRestartNeeded - Server restart flag (server has to be restarted after variable change if this flag is set)

dataType - Data type for server configuration variable

description - Description

See Also:

ServerVariableDataType

ServerVariable

public ServerVariable(org.netxms.base.NXCPMessage msg,
                      long baseId)

Create variable from NXCP message

Parameters:

msg - NXCP message

baseId - base object id

Method Detail

addPossibleValue

public void addPossibleValue(org.netxms.base.NXCPMessage msg,
                             long baseId)

Add possible value to variable from NXCP message

Parameters:

msg - NXCP Message

baseId - value base id

getName

public String getName()

Returns:

Varaible's name

getValueForDisplay

public String getValueForDisplay()

Get variable's value for display. Will replace numeric value with textual description when possible.

Returns:

Variable's value prepared for display

getValue

public String 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

public ServerVariableDataType getDataType()

Returns:

Variable`s data type

getDescription

public String getDescription()

Returns:

Variable`s description

isServerRestartNeeded

public boolean isServerRestartNeeded()

Returns:

Server restart flag

getPossibleValues

public HashMap<String,String> getPossibleValues()

Returns:

A list of possible variable values

getDefaultValue

public String getDefaultValue()

Returns:

Variable`s default value

getDefaultValueForDisplay

public String 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