IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.event
Interface Handler

All Known Implementing Classes:
BTTHandler, MirrorHandler

public interface Handler

This interface is used by classes to process the events generated by Notifier instances. Each class that includes the Handler interface must implement all of these methods.


Method Summary
 Handler dispatchEvent(DSEEventObject anEvent)
          This method is called when a Handler get the interested event anEvent from message queue.
 void handleEvent(java.lang.String anEventName, java.lang.String aNotifierName)
          Indicates that the Handler is interested in the event anEventName.
 void stopHandlingEvent(java.lang.String anEventName, java.lang.String aNotifierName)
          Removes the Handler from the list of Handlers for the specific event.
 

Method Detail

dispatchEvent

public Handler dispatchEvent(DSEEventObject anEvent)
This method is called when a Handler get the interested event anEvent from message queue.


handleEvent

public void handleEvent(java.lang.String anEventName,
                        java.lang.String aNotifierName)
                 throws DSEInvalidArgumentException
Indicates that the Handler is interested in the event anEventName. This method should call the EventManager class to register the Handler as interested in the event anEventName from the Notifier aNotifierName. This method throws a DSEInvalidArgumentException.

Throws:
DSEInvalidArgumentException

stopHandlingEvent

public void stopHandlingEvent(java.lang.String anEventName,
                              java.lang.String aNotifierName)
                       throws DSEInvalidArgumentException,
                              DSEHandlerNotFoundException
Removes the Handler from the list of Handlers for the specific event. This method throws a "DSEInvalidArgumentException" and a "DSEHandlerNotFoundException."

Throws:
DSEInvalidArgumentException
DSEHandlerNotFoundException

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005