com.tivoli.twg.monitor.api
Class TWGMonDoubleThresholdData

java.lang.Object
  extended bycom.tivoli.twg.monitor.api.TWGMonDoubleThresholdData

public class TWGMonDoubleThresholdData
extends java.lang.Object

This is the TWGMonDoubleThresholdData class. This class is used as a container for the threshold idata needed between the monitor api and server.


Constructor Summary
TWGMonDoubleThresholdData()
          This is the constructor for manually building the NumericThreshold
TWGMonDoubleThresholdData(double he, double hw, double lw, double le)
          This is the constructor for building a filled in NumericThreshold
 
Method Summary
 void clearHighError()
          method to indicate the high error value is cleared of of the data object
 void clearHighWarning()
          method to indicate the high warning value is cleared of of the data object
 void clearLowError()
          method to indicate the low error value is cleared of of the data object
 void clearLowWarning()
          method to indicate the low warning value is cleared of of the data object
 double getHighError()
          returns a double which contains the value that was specified for the high error setpoint for the threshold.
 double getHighWarning()
          returns a double which contains the value that was specified for the high warning setpoint for the threshold.
 double getLowError()
          returns a double which contains the value that was specified for the low error setpoint for the threshold.
 double getLowWarning()
          returns a double which contains the value that was specified for the low warning setpoint for the threshold.
 boolean hasSetHighError()
          returns a boolean indicating if the high error value is set
 boolean hasSetHighWarning()
          returns a boolean indicating if the high warning value is set
 boolean hasSetLowError()
          returns a boolean indicating if the low error value is set
 boolean hasSetLowWarning()
          returns a boolean indicating if the low warning value is set
 boolean isAcceptable()
          returns indication if the data in the object would be acceptable to the server
 void setHighError(double parm)
          method to set the threshold value for high error for a numeric threshold
 void setHighWarning(double parm)
          method to set the threshold value for high warning for a numeric threshold
 void setLowError(double parm)
          method to set the threshold value for low error for a numeric threshold
 void setLowWarning(double parm)
          method to set the threshold value for low warning for a numeric threshold
 java.lang.String toString()
          returns a string with debug information that represents the current state of the object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TWGMonDoubleThresholdData

public TWGMonDoubleThresholdData()
This is the constructor for manually building the NumericThreshold


TWGMonDoubleThresholdData

public TWGMonDoubleThresholdData(double he,
                                 double hw,
                                 double lw,
                                 double le)
This is the constructor for building a filled in NumericThreshold

Parameters:
he - high error value
hw - high warning value
lw - low warning value
le - low error value
Method Detail

setHighError

public void setHighError(double parm)
method to set the threshold value for high error for a numeric threshold

Parameters:
parm - the threshold value

setHighWarning

public void setHighWarning(double parm)
method to set the threshold value for high warning for a numeric threshold

Parameters:
parm - the threshold value

setLowWarning

public void setLowWarning(double parm)
method to set the threshold value for low warning for a numeric threshold

Parameters:
parm - the threshold value

setLowError

public void setLowError(double parm)
method to set the threshold value for low error for a numeric threshold

Parameters:
parm - the threshold value

clearHighError

public void clearHighError()
method to indicate the high error value is cleared of of the data object


clearHighWarning

public void clearHighWarning()
method to indicate the high warning value is cleared of of the data object


clearLowWarning

public void clearLowWarning()
method to indicate the low warning value is cleared of of the data object


clearLowError

public void clearLowError()
method to indicate the low error value is cleared of of the data object


getHighError

public double getHighError()
returns a double which contains the value that was specified for the high error setpoint for the threshold. This value will only be valid if getAlertTypes() methods return byte indicates that this value is present.

Returns:
double containing the high error setting on a numeric threshold

getHighWarning

public double getHighWarning()
returns a double which contains the value that was specified for the high warning setpoint for the threshold. This value will only be valid if getAlertTypes() methods return byte indicates that this value is present.

Returns:
double containing the high warning setting on a numeric threshold

getLowWarning

public double getLowWarning()
returns a double which contains the value that was specified for the low warning setpoint for the threshold. This value will only be valid if getAlertTypes() methods return byte indicates that this value is present.

Returns:
double containing the low warning setting on a numeric threshold

getLowError

public double getLowError()
returns a double which contains the value that was specified for the low error setpoint for the threshold. This value will only be valid if getAlertTypes() methods return byte indicates that this value is present.

Returns:
double containing the low error setting on a numeric threshold

isAcceptable

public boolean isAcceptable()
returns indication if the data in the object would be acceptable to the server

Returns:
boolean indicating if the threshold data checks out

hasSetHighError

public boolean hasSetHighError()
returns a boolean indicating if the high error value is set

Returns:
boolean containing the setting indicating if the high error value was set

hasSetHighWarning

public boolean hasSetHighWarning()
returns a boolean indicating if the high warning value is set

Returns:
boolean containing the setting indicating if the high warning value was set

hasSetLowWarning

public boolean hasSetLowWarning()
returns a boolean indicating if the low warning value is set

Returns:
boolean containing the setting indicating if the low warning value was set

hasSetLowError

public boolean hasSetLowError()
returns a boolean indicating if the low error value is set

Returns:
boolean containing the setting indicating if the low error value was set

toString

public java.lang.String toString()
returns a string with debug information that represents the current state of the object

Returns:
String with debug information to display about the state of the object