com.tivoli.twg.monitor.api
Class TWGMonAttribute

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

public class TWGMonAttribute
extends java.lang.Object

This is the TWGMonAttribute class. This is a class for managing the information associated with an attribute being used through the Monitor API class, TWGMonAPI.


Constructor Summary
TWGMonAttribute(com.tivoli.twg.monitor.api.TWGMonDataHolder data, TWGMonPath progPath, TWGMonPath dispPath, long moid, long handle)
          This is the constructor for building the Attribute
 
Method Summary
 void deregisterUpdateListener(TWGMonAttributeUpdateListener listener)
          deregisters a listener with the object.
 java.lang.String getDataAsString()
          gets the current value of the attribute in the form of a formated unicode string
 boolean hasThresholdAlert()
          returns a flag indicating if the attribute is in alert state
 boolean hasThresholdSet()
          returns a flag indicating if the attribute has a threshold applied
 boolean hasValidData()
          returns a flag indicating if the attribute has a valid data point
 void registerUpdateListener(TWGMonAttributeUpdateListener listener)
          registers a listener with the attribute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TWGMonAttribute

public TWGMonAttribute(com.tivoli.twg.monitor.api.TWGMonDataHolder data,
                       TWGMonPath progPath,
                       TWGMonPath dispPath,
                       long moid,
                       long handle)
This is the constructor for building the Attribute

Method Detail

registerUpdateListener

public void registerUpdateListener(TWGMonAttributeUpdateListener listener)
registers a listener with the attribute. when the data for the attribute is updated the user will receive a call back.

Parameters:
listener - the object to be called back when the data for this object is updated
Since:
Director 2.11
See Also:
TWGMonAttributeUpdateListener

deregisterUpdateListener

public void deregisterUpdateListener(TWGMonAttributeUpdateListener listener)
deregisters a listener with the object. the object passed in will no longer receive an update notification

Parameters:
listener - the object to no longer call on data updates
Since:
Director 2.11
See Also:
TWGMonAttributeUpdateListener

hasValidData

public boolean hasValidData()
returns a flag indicating if the attribute has a valid data point

Returns:
boolean indicating if the attribute has a valid data point

getDataAsString

public java.lang.String getDataAsString()
gets the current value of the attribute in the form of a formated unicode string

Returns:
String containing the formated value returned for the attribute

hasThresholdSet

public boolean hasThresholdSet()
returns a flag indicating if the attribute has a threshold applied

Returns:
boolean indicating if the attribute has a threshold applied

hasThresholdAlert

public boolean hasThresholdAlert()
returns a flag indicating if the attribute is in alert state

Returns:
boolean indicating if the attribute has an unresolved event