com.tivoli.twg.monitor.api
Class TWGMonStringThresholdData

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

public class TWGMonStringThresholdData
extends java.lang.Object

This is the TWGMonStringThresholdData class. This class is used as a container for the threshold string data needed between the monitor api and server.


Field Summary
static byte ERROR_THRESHOLD
           
static byte NORMAL_THRESHOLD
           
static byte WARNING_THRESHOLD
           
 
Constructor Summary
TWGMonStringThresholdData()
          This is the constructor for manually building the StringThreshold
TWGMonStringThresholdData(StringValueSet eStrSet, StringValueSet wStrSet, StringValueSet nStrSet)
          This is the constructor for building a filled in StringThreshold
 
Method Summary
 byte getDefaultStringType()
          gets the default event type for strings that are not in any of the string sets contained in this object
 StringValueSet getErrorStrings()
          returns a list of strings which make up the set of strings that will be checked to decide when an error state exists for a string threshold
 StringValueSet getNormalStrings()
          returns a list of strings which make up the set of strings that will be checked to decide when a normal state exists for a string threshold
 StringValueSet getWarningStrings()
          returns a list of strings which make up the set of strings that will be checked to decide when a warning state exists for a string threshold
 boolean isAcceptable()
          returns indication if the data in the object would be acceptable to the server
 void setDefaultType(byte parm)
          sets the default event type for strings that are not in any of the string sets contained in this object
 void setErrorStrings(StringValueSet strings)
          method to set the threshold string set for error strings for a string threshold
 void setNormalStrings(StringValueSet strings)
          method to set the threshold string set for normal strings for a string threshold
 void setWarningStrings(StringValueSet strings)
          method to set the threshold string set for warning strings for a string 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
 

Field Detail

ERROR_THRESHOLD

public static final byte ERROR_THRESHOLD
See Also:
Constant Field Values

WARNING_THRESHOLD

public static final byte WARNING_THRESHOLD
See Also:
Constant Field Values

NORMAL_THRESHOLD

public static final byte NORMAL_THRESHOLD
See Also:
Constant Field Values
Constructor Detail

TWGMonStringThresholdData

public TWGMonStringThresholdData()
This is the constructor for manually building the StringThreshold


TWGMonStringThresholdData

public TWGMonStringThresholdData(StringValueSet eStrSet,
                                 StringValueSet wStrSet,
                                 StringValueSet nStrSet)
This is the constructor for building a filled in StringThreshold

Parameters:
eStrSet - high error string set
wStrSet - high warning string set
nStrSet - normal state string set
Method Detail

setDefaultType

public void setDefaultType(byte parm)
sets the default event type for strings that are not in any of the string sets contained in this object

Parameters:
parm - value indicating the type of string threshold event to generate for unknown strings it must be set to one of the constant values specified in this class

setErrorStrings

public void setErrorStrings(StringValueSet strings)
method to set the threshold string set for error strings for a string threshold

Parameters:
strings - the threshold string set

setWarningStrings

public void setWarningStrings(StringValueSet strings)
method to set the threshold string set for warning strings for a string threshold

Parameters:
strings - the threshold string set

setNormalStrings

public void setNormalStrings(StringValueSet strings)
method to set the threshold string set for normal strings for a string threshold

Parameters:
strings - the threshold string set

getDefaultStringType

public byte getDefaultStringType()
gets the default event type for strings that are not in any of the string sets contained in this object

Returns:
byte value indicating the type of string threshold event to generate for unknown strings it will return one of the constant values defined in this class

getErrorStrings

public StringValueSet getErrorStrings()
returns a list of strings which make up the set of strings that will be checked to decide when an error state exists for a string threshold

Returns:
StringValueSet containing the complete set of error state strings

getWarningStrings

public StringValueSet getWarningStrings()
returns a list of strings which make up the set of strings that will be checked to decide when a warning state exists for a string threshold

Returns:
StringValueSet containing the complete set of warning state strings

getNormalStrings

public StringValueSet getNormalStrings()
returns a list of strings which make up the set of strings that will be checked to decide when a normal state exists for a string threshold

Returns:
StringValueSet containing the complete set of normal state strings

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

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