com.tivoli.twg.monitor.api
Class TWGMonNode

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

public class TWGMonNode
extends java.lang.Object

This is the monitor API Attribute Node class. This class encapsulates the information for individual nodes in the response to a TWGMonAPI.findNodes or TWGMonAPI.findNodesAsync request for attribute tree information


Method Summary
 int getAttributeType()
          Gets the type of node the node is
 java.lang.String getDispName()
          Gets the Displayable Node name and return it to the caller
 java.util.Locale getLocale()
          Gets the locale information for the node
 java.lang.String getProgName()
          Gets the Program Node name and return it to the caller
 LongValueSet getSystems()
          Gets the list of managed system ids and returns it to the caller
 int getSystemsCount()
          Gets the count of systems that are part of the systems set
 boolean isDataNode()
          Gets indication if the node is a node that can provide monitorable data
 boolean isPathNode()
          Gets indication if the node is a branch point that leads to more branch points or data nodes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSystems

public LongValueSet getSystems()
Gets the list of managed system ids and returns it to the caller

Returns:
LongValueSet with a systems set with list of unique system ids the node was found on.

getSystemsCount

public int getSystemsCount()
Gets the count of systems that are part of the systems set

Returns:
int systems set size

getDispName

public java.lang.String getDispName()
Gets the Displayable Node name and return it to the caller

Returns:
String with the displayable name for the node

getProgName

public java.lang.String getProgName()
Gets the Program Node name and return it to the caller

Returns:
String with the programatic name for the node

isDataNode

public boolean isDataNode()
Gets indication if the node is a node that can provide monitorable data

Returns:
boolean indicating if node is leaf or path node.

isPathNode

public boolean isPathNode()
Gets indication if the node is a branch point that leads to more branch points or data nodes.

Returns:
boolean indicating if node is leaf or path node.

getAttributeType

public int getAttributeType()
Gets the type of node the node is

Returns:
int with monitor type encoded in it.

getLocale

public java.util.Locale getLocale()
Gets the locale information for the node

Returns:
Locale locale the display info represents for the node