org.ow2.bonita.definition
Interface TxHook


public interface TxHook

Implementing this interface allows to execute 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 TxHook interface is intended to use APIs acceded by the APIAccessor(provided into parameters of the execute() method) that can do write operations into the engine database:

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

If at process definition (with proEd) the designer has chosen: hook with rollback,
implementing this interface for the hook is well suited.
If the designer has chosen: hook without rollback,
implementing this interface for the hook is not authorized by the engine (will generate an exception).


Method Summary
 void execute(APIAccessor accessor, org.ow2.bonita.facade.runtime.ActivityInstance<org.ow2.bonita.facade.runtime.ActivityBody> activityInstance)
          Method of the interface to be implemented.
 

Method Detail

execute

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

Parameters:
accessor - The APIAccessor interface to access: RuntimeAPI, ManagementAPI, DefinitionAPI, CommandAPI.
activityInstance - the record of the current activity.
Throws:
java.lang.Exception - If an Exception has occurred.


Copyright © 2009 OW2 Consortium. All Rights Reserved.