com.wrq.vhi.script.api
Class OperationEventHandler

java.lang.Object
  extended by com.wrq.vhi.script.api.OperationEventHandler
All Implemented Interfaces:
EventHandler

public abstract class OperationEventHandler
extends java.lang.Object
implements EventHandler

Abstract base class for an operation event handler. All classes that extend this class appear as operation event handlers in the VHI design tool.


Field Summary
 
Fields inherited from interface com.wrq.vhi.script.api.EventHandler
DEFAULT_TIMEOUT
 
Constructor Summary
OperationEventHandler()
           
 
Method Summary
 void executeOperation(ExecuteOperationEvent event)
          Called to execute an operation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OperationEventHandler

public OperationEventHandler()
Method Detail

executeOperation

public void executeOperation(ExecuteOperationEvent event)
                      throws ApptrieveException
Called to execute an operation. Upon returning from this method, VHI will wait until one of the model-defined destination entities is recognized. If none are recognized within the operation's model defined timeout, the operation fails.

During the course of the event, VHI will not process data from the host while the event handler is executing. The host data will only be processed during callbacks to VHI. Thus, at the points where the event handler needs to wait for the host to respond, the event handler should use the appropriate wait callbacks on the ScriptHostSession interface.

If an exception is thrown from this method the operation will fail.

Parameters:
event - the event instance
Throws:
ApptrieveException