org.ow2.bonita.definition
Interface Hook


public interface Hook

Implementing this interface allows to execute not transactional hooks.

Hook and deadline features are requiring the implementation of TxHook or Hook interface. Within xpdl definition, the hook feature is specified within external attributes of Activity element.
There is two parameters defining the hook:

For deadline feature, name of the class that implements this interface is specified within XPDL Deadline element.
The event name (internal to the engine) is ON_DEADLINE.
This Hook interface is intended to use APIs acceded by the the QueryAPIAccessor (provided into parameters of the execute() method) that should do read operations into the engine database:

If an exception occurs the exception is catched by the engine and no rollback is performed. Note: In the opposite if implementing TxHook interface the exception is not catched but raised by the engine and the transaction is not commited (rollback).

This interface can be implemented for hook if at process definition (under proed) the designer has chosen:


Method Summary
 void execute(QueryAPIAccessor accessor, ActivityInstance<ActivityBody> activityInstance)
          Method of the interface to be implemented.
Put in all your required user-defined operations.
 

Method Detail

execute

void execute(QueryAPIAccessor accessor,
             ActivityInstance<ActivityBody> activityInstance)
             throws java.lang.Exception
Method of the interface to be implemented.
Put in all your required user-defined operations.

Parameters:
accessor - The QueryAPIAccessor interface to access: QueryRuntimeAPI or QueryDefinitionAPI.
activityInstance - the record of the current activity.
Throws:
java.lang.Exception - If an Exception has occurred.


Copyright © 2009 OW2 Consortium. All Rights Reserved.