com.adventnet.nms.rta.fw.client
Interface ProbePanelListener

public interface ProbePanelListener

This interface has to be implemented by the RTA UI component(panel on the right side in the RTA UI) implementation. This interface has few methods, which will be called based on the node operation(select/modify etc).

Method Summary

java.lang.String	getModuleDisplayName() Returns the display name of the module.
int	getModuleID() This should return some unique integer values.
java.util.Vector	getRequiredXMLFileNames() This should return list of configuration files, the content of those files will be returned while selecting the probe.
java.lang.Object	getUserObject() This will be called when the node switching happens between the leaf nodes of the probe.
void	setUserObject(java.lang.Object uo) This will be called when the node switching happens between the leaf nodes of the probe.
void	updateUserObject(java.lang.Object uo) This will be called when the name of the leaf node of the probe is edited.

Method Detail

setUserObject

public void setUserObject(java.lang.Object uo)

This will be called when the node switching happens between the leaf nodes of the probe. Whenever a leaf node is selected that particular node's RTAData object will be passed to this method. Here the data is read and populated in the UI appropriately.

Parameters:

uo - RTAData of the RTA UI implementation

updateUserObject

public void updateUserObject(java.lang.Object uo)

This will be called when the name of the leaf node of the probe is edited. Whenever a leaf node is modified that particular node in the ProbePanel Component(component which shows the Probes& leaf nodes in the RTA UI). After editing the name of the leaf node, this method will be called with that node's RTAData implementation with the modified name. Here the implementation has to be provided appropriately.

Parameters:

uo - RTAData of the RTA UI implementation

getUserObject

public java.lang.Object getUserObject()

This will be called when the node switching happens between the leaf nodes of the probe. Whenever a leaf node is selected the previous node's RTAData object will have to be given to the RTA component, which maintains the detail of the node data.So the RTAData has to be formed in implementation for the selected node and it has to be returned, whenever this node is selected afterwards, the latest values will be shown in the UI.

Returns:

RTAData of the RTA UI implementation

getModuleID

public int getModuleID()

This should return some unique integer values. which will be used for communication.

Returns:

unique id to idedtify this RTA UI implementation

getRequiredXMLFileNames

public java.util.Vector getRequiredXMLFileNames()

This should return list of configuration files, the content of those files will be returned while selecting the probe.

Returns:

list of configuration files which are required for the RTA UI implementation

getModuleDisplayName

public java.lang.String getModuleDisplayName()

Returns the display name of the module.

Returns:

Display name of the RTA UI module, which will be displayed in the Status bar of the RTA screen.