|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.monitor.api.TWGMonThreshold
This is the TWGMonThreshold class. This class is used in the monitor API.
Field Summary | |
---|---|
static byte |
CHANGED_THRESHOLD
|
static byte |
ENUMERATED_THRESHOLD
|
static byte |
ERROR_THRESHOLD
|
static byte |
HIGH_ERROR_THRESHOLD
|
static byte |
HIGH_WARNING_THRESHOLD
|
static byte |
INVALID_STATE_THRESHOLD
|
static byte |
INVALID_THRESHOLD
|
static byte |
LOW_ERROR_THRESHOLD
|
static byte |
LOW_WARNING_THRESHOLD
|
static byte |
NORMAL_THRESHOLD
|
static byte |
NUMERIC_THRESHOLD
|
static byte |
STRING_THRESHOLD
|
static byte |
WARNING_THRESHOLD
|
Constructor Summary | |
---|---|
TWGMonThreshold()
This is the constructor for manually building the Threshold for the GUI or SDK |
Method Summary | |
---|---|
byte |
getChangeBasedSeverity()
Gets the monoitor based severity selection that should be associated with threshold events generated for this threshold if change based. |
byte |
getDataType()
returns a flag byte indicating the type of threshold this threshold represents (String, numeric, etc.) jret byte with flags indicating the type of threshold this object represents |
java.lang.String |
getDescription()
returns a string that the user specified when the threshold was created. |
TWGMonPath |
getDispPath()
returns the information that describes the path that is being thresholded in a form that is appropriate for display on a console |
java.util.Locale |
getDispPathLocale()
returns the locale that was specified for the displayable strings when this threshold was created |
TWGMonDoubleThresholdData |
getDoubleData()
returns the numeric threshold object from a numeric type threshold |
TWGMonThresholdId |
getID()
Returns the object that holds the identification information for objects of this class. |
java.lang.String |
getName()
returns a string that provides a name for the threshold. |
TWGMonPath |
getProgPath()
returns the information that describes the path that is being thresholded in a form that is appropriate for programatic decisions |
int |
getQueueDepth()
gets a numeric value that indicates how many events will be queued for this threshold while the server is not available. |
int |
getResendDelay()
gets a numeric value that indicates how long a condition must continue to exist after an initial threshold event is generated before another event is generated signaling that the condition continues to exist |
int |
getSendDelay()
gets a numeric value that indicates how long a condition must first exist before an initial threshold event is generated |
TWGMonStringThresholdData |
getStringData()
returns the string threshold object from a string type threshold |
int |
getTargetGroupID()
returns an int that contains the filter group object ID that this threshold was established for. |
long |
getTargetSystemID()
returns an int that contains the managed object ID that this threshold was established for. |
boolean |
isAcceptable()
returns indication if the data in the object would be acceptable to the server |
boolean |
isChangeBased()
Gets whether this threshold should generate events on changes |
boolean |
isEnabled()
returns the status of the threshold with reguard to generating events |
boolean |
isEnumerated()
returns the status of the threshold with reguard to enumerated values |
boolean |
isNewThreshold()
Gets whether this object contains a thresholdId from the server |
boolean |
isValid()
Gets whether this object contains valid data. |
void |
setChangeBased(boolean changeType)
provides an interface to indicate whether the threshold should generate events on changes rather than comparison against set values |
void |
setChangeBased(boolean changeType,
byte monSeverity)
provides an interface to indicate whether the threshold should generate events on changes rather than comparison against set values |
void |
setDescription(java.lang.String parm)
provides a method to set the descriptive text that accompanies the threshold |
void |
setDisplayablePath(TWGMonPath path,
java.util.Locale locale)
method to set the displayable version of the attribute path to threshold |
void |
setDoubleData(TWGMonDoubleThresholdData data)
Provides an interface to set the Double Threshold data object |
void |
setEnabled(boolean enable)
provides an interface to indicate whether the threshold should be enabled to generate events or not |
void |
setEnumerated(boolean enumerated)
provides an interface to indicate whether the threshold has enumeration data on the server |
void |
setLocale(java.util.Locale parm)
provides a method to set the Locale that the threshold information refers to |
void |
setName(java.lang.String parm)
provides a method to set the threshold name |
void |
setProgramaticPath(TWGMonPath path)
method to set the programmatic version of the attribute path to threshold |
void |
setQueueDepth(int parm)
provides a method to set the event queue depth for this threshold. |
void |
setResendDelay(int parm)
the between resends of event for a threshold setting |
void |
setSendDelay(int parm)
provides a method to set the time the threshold condition must continuously exist before event is generated |
void |
setStringData(TWGMonStringThresholdData data)
Provides an interface to set the String Threshold data object |
void |
setTargetGroupID(int parm)
used to set the id for the group filter object that specifies which systems this threshold applies to. |
void |
setTargetSystemID(long parm)
used to set the id for the managed object that specifies which system this threshold applies to. |
void |
setThreshId(TWGMonThresholdId parm)
provides a method to set the thresholdId object in this object |
java.lang.String |
toString()
returns a string string for debuging that contains in readable text 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 |
public static final byte INVALID_THRESHOLD
public static final byte NUMERIC_THRESHOLD
public static final byte STRING_THRESHOLD
public static final byte ENUMERATED_THRESHOLD
public static final byte INVALID_STATE_THRESHOLD
public static final byte HIGH_ERROR_THRESHOLD
public static final byte LOW_ERROR_THRESHOLD
public static final byte ERROR_THRESHOLD
public static final byte HIGH_WARNING_THRESHOLD
public static final byte LOW_WARNING_THRESHOLD
public static final byte WARNING_THRESHOLD
public static final byte NORMAL_THRESHOLD
public static final byte CHANGED_THRESHOLD
Constructor Detail |
public TWGMonThreshold()
Method Detail |
public void setDoubleData(TWGMonDoubleThresholdData data)
data
- threshold data information object to setpublic void setStringData(TWGMonStringThresholdData data)
data
- threshold data information object to setpublic void setEnabled(boolean enable)
enable
- indicates whether events are desired from this thresholdpublic void setEnumerated(boolean enumerated)
enumerated
- indicates whether the threshold has enumeration data on the serverpublic void setChangeBased(boolean changeType)
changeType
- indicates whether change based events are desired from this thresholdpublic void setChangeBased(boolean changeType, byte monSeverity)
changeType
- indicates whether change based events are desired from this thresholdmonSeverity
- indicates what monitor severity to associate with events generated
for change based thresholdsWARNING_THRESHOLD
,
ERROR_THRESHOLD
,
NORMAL_THRESHOLD
public void setTargetGroupID(int parm)
parm
- id of the group filter that this threshold applies topublic void setTargetSystemID(long parm)
parm
- id of the system that this threshold applies topublic void setResendDelay(int parm)
parm
- time in seconds between resends. 0 = send only once per entry to
statepublic void setSendDelay(int parm)
parm
- time in seconds event must exist. 0 = send immediatelypublic void setQueueDepth(int parm)
parm
- queue depth. 0 = no queuing for the thresholdpublic void setLocale(java.util.Locale parm)
parm
- locale that the strings refer topublic void setName(java.lang.String parm)
parm
- string with the name to use to refer to the thresholdpublic void setDescription(java.lang.String parm)
parm
- free form text that may be used to describe the purpose of the thresholdpublic void setThreshId(TWGMonThresholdId parm)
parm
- the threshold id object to place in this objectpublic void setProgramaticPath(TWGMonPath path)
public void setDisplayablePath(TWGMonPath path, java.util.Locale locale)
public boolean isEnabled()
public boolean isEnumerated()
public boolean isChangeBased()
public byte getChangeBasedSeverity()
public TWGMonThresholdId getID()
public byte getDataType()
public int getTargetGroupID()
public long getTargetSystemID()
public int getResendDelay()
public int getSendDelay()
public int getQueueDepth()
public java.util.Locale getDispPathLocale()
public java.lang.String getName()
public java.lang.String getDescription()
public TWGMonDoubleThresholdData getDoubleData()
public TWGMonStringThresholdData getStringData()
public TWGMonPath getProgPath()
public TWGMonPath getDispPath()
public boolean isValid()
public boolean isAcceptable()
public boolean isNewThreshold()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |