AdventNet Web NMS 4 DMS API Specification

com.adventnet.nms.rta.fw.client
Interface ProbePanelActions
All Known Implementing Classes:
ProbePanelActionsAdapter

public interface ProbePanelActions

This interface has to be implemented, if the user wants to receive the notification before/after the actions(add/modify/delete) performed on the RTA UI. The impementation class has to be registered with the ProbePanel class using the method ProbePanel.registerForActions(com.adventnet.nms.rta.fw.client.ProbePanelActions). Once registered, the notification will be sent to the implementation class, whenever any action is performed in the Probe Panel(middle part of the RTA UI screen) of the RTA UI. If the user wants to override few of the methods in this interface, then ProbePanelActionsAdapter class which has the default implementation, can be extended.


Method Summary
 void postAdd(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called after a leaf node has been added for a DMS.
 void postApply(AbstractRTADataModel dataModel, java.util.ArrayList modifiedProbes)
          This method will be called after applied the changes to the server.
 void postCopy(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called after a leaf node has been copied in the DMS.
 void postCut(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called after a leaf node has been cut from the DMS.
 void postDelete(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called after a leaf node has been deleted from a DMS.
 void postModify(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String oldValue, java.lang.String newValue)
          This method will be called after a leaf node(node name) has been modified for a DMS.
 void postPaste(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called after a leaf node has been pasted into the DMS.
 void postSelection(AbstractRTADataModel dataModel, java.lang.String oldProbeName, java.lang.String oldValue, java.lang.String newProbeName, java.lang.String newValue)
          This method will be called after a leaf node has been selected in the tree.
 void preAdd(AbstractRTADataModel dataModel, java.lang.String probeName)
          This method will be called when a user tries to add a leaf node for a DMS.
 void preApply(AbstractRTADataModel dataModel, java.util.ArrayList modifiedProbes)
          This method will be called when a user tries to apply the changes that have been made.
 void preCopy(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called when a user tries to copy a leaf node in a DMS.
 void preCut(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called when a user tries to cut a leaf node from a DMS.
 void preDelete(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called when a user tries to delete a leaf node for a DMS.
 void preModify(AbstractRTADataModel dataModel, java.lang.String probeName, java.lang.String value)
          This method will be called when a user tries to modify a leaf node(node name) for a DMS.
 void prePaste(AbstractRTADataModel dataModel, java.lang.String probeName)
          This method will be called when a user tries to paste a leaf node in a DMS.
 void preSelection(AbstractRTADataModel dataModel, java.lang.String oldProbeName, java.lang.String oldValue, java.lang.String newProbeName, java.lang.String newValue)
          This method will be called when a user tries to select a node in the tree.
 

Method Detail

preAdd

public void preAdd(AbstractRTADataModel dataModel,
                   java.lang.String probeName)
This method will be called when a user tries to add a leaf node for a DMS. This will be invoked before the node gets added into the DMS. Here user can decide whether to allow the addition of node or not. If it needs to be allowed, he can simply leave it else he can throw an RTAException specifying the proper reason. The thrown message will be displayed to the user and and addition will not be performed.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS

postAdd

public void postAdd(AbstractRTADataModel dataModel,
                    java.lang.String probeName,
                    java.lang.String value)
This method will be called after a leaf node has been added for a DMS.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has been added

preModify

public void preModify(AbstractRTADataModel dataModel,
                      java.lang.String probeName,
                      java.lang.String value)
This method will be called when a user tries to modify a leaf node(node name) for a DMS. User can throw RTAException with proper message to disallow the modification operation.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has to be modified

postModify

public void postModify(AbstractRTADataModel dataModel,
                       java.lang.String probeName,
                       java.lang.String oldValue,
                       java.lang.String newValue)
This method will be called after a leaf node(node name) has been modified for a DMS.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
oldValue - existing name of the tree node that has to be modified
newValue - the modified name of the tree node

preDelete

public void preDelete(AbstractRTADataModel dataModel,
                      java.lang.String probeName,
                      java.lang.String value)
This method will be called when a user tries to delete a leaf node for a DMS. User can throw RTAException with proper message to disallow the deletion operation.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has to be deleted

postDelete

public void postDelete(AbstractRTADataModel dataModel,
                       java.lang.String probeName,
                       java.lang.String value)
This method will be called after a leaf node has been deleted from a DMS.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has been deleted

preCopy

public void preCopy(AbstractRTADataModel dataModel,
                    java.lang.String probeName,
                    java.lang.String value)
This method will be called when a user tries to copy a leaf node in a DMS. User can throw RTAException with proper message to disallow the copy operation.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has to be copied

postCopy

public void postCopy(AbstractRTADataModel dataModel,
                     java.lang.String probeName,
                     java.lang.String value)
This method will be called after a leaf node has been copied in the DMS.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has been copied

preCut

public void preCut(AbstractRTADataModel dataModel,
                   java.lang.String probeName,
                   java.lang.String value)
This method will be called when a user tries to cut a leaf node from a DMS. User can throw RTAException with proper message to disallow the cut operation.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has to be cut( this is like moving this node to the other DMS)

postCut

public void postCut(AbstractRTADataModel dataModel,
                    java.lang.String probeName,
                    java.lang.String value)
This method will be called after a leaf node has been cut from the DMS.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has been cut( this is like moving this node to the other DMS)

prePaste

public void prePaste(AbstractRTADataModel dataModel,
                     java.lang.String probeName)
This method will be called when a user tries to paste a leaf node in a DMS. User can throw RTAException with proper message to disallow the paste operation.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS

postPaste

public void postPaste(AbstractRTADataModel dataModel,
                      java.lang.String probeName,
                      java.lang.String value)
This method will be called after a leaf node has been pasted into the DMS.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
probeName - name of the DMS
value - name of the node which has been pasted (added into a DMS)

preApply

public void preApply(AbstractRTADataModel dataModel,
                     java.util.ArrayList modifiedProbes)
This method will be called when a user tries to apply the changes that have been made. User can throw RTAException with proper message to disallow the apply operation.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
modifiedProbes - list of modified DMSs

postApply

public void postApply(AbstractRTADataModel dataModel,
                      java.util.ArrayList modifiedProbes)
This method will be called after applied the changes to the server.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
modifiedProbes - list of modified DMSs

preSelection

public void preSelection(AbstractRTADataModel dataModel,
                         java.lang.String oldProbeName,
                         java.lang.String oldValue,
                         java.lang.String newProbeName,
                         java.lang.String newValue)
This method will be called when a user tries to select a node in the tree.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
oldProbeName - name of the DMS before performing the selection operation
oldValue - name of the tree node that was selected in the oldProbe
newProbeName - name of the DMS after performing the selection operation
newValue - name of the tree node that is selected in the current DMS

postSelection

public void postSelection(AbstractRTADataModel dataModel,
                          java.lang.String oldProbeName,
                          java.lang.String oldValue,
                          java.lang.String newProbeName,
                          java.lang.String newValue)
This method will be called after a leaf node has been selected in the tree.
Parameters:
dataModel - data model used in the RTA UI implementation, the data model value should either be the instance of DefaultSingleObjectModel or DefaultMultiObjectModel class.
oldProbeName - name of the DMS before performing the selection operation
oldValue - name of the tree node that was selected in the oldProbe
newProbeName - name of the DMS after performing the selection operation
newValue - name of the tree node that is selected in the current DMS

AdventNet Web NMS 4 DMS API Specification