com.wrq.vhi.script.api

Class ProcedureEventHandler

java.lang.Object

com.wrq.vhi.script.api.ProcedureEventHandler

All Implemented Interfaces:

EventHandler

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

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

Field Summary

Fields inherited from interface com.wrq.vhi.script.api.EventHandler

DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ProcedureEventHandler()

Method Summary

Modifier and Type	Method and Description
ProcedureRecordSet	executeProcedure(ExecuteProcedureEvent event) Called to execute a procedure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcedureEventHandler

public ProcedureEventHandler()

Method Detail

executeProcedure

public ProcedureRecordSet executeProcedure(ExecuteProcedureEvent event)
                                    throws ApptrieveException

Called to execute a procedure. The event can either be used to modify the input and/or output of the default procedure, or can be used to fully script a procedure's implementation.

If an exception is thrown from this event the procedure will fail.

Parameters:

event - the event instance

Returns:

the procedure result or null if none

Throws:

ApptrieveException