jadex.bdibpmn

Class BpmnPlanExecutor

java.lang.Object

jadex.bdibpmn.BpmnPlanExecutor

All Implemented Interfaces:

IPlanExecutor, Serializable

public class BpmnPlanExecutor
extends Object
implements IPlanExecutor, Serializable

A plan executor for plans modeled in BPMN. These plan steps are executed on the agent thread.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BpmnPlanExecutor() Create a new BPMN plan executor.

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup(BDIInterpreter interpreter, Object rplan) Called on termination of a plan.
Object	createPlanBody(BDIInterpreter interpreter, Object rcapability, Object rplan) Create the body of a plan.
void	eventWaitFor(BDIInterpreter interpreter, Object rplan) Block a plan until an event matching the wait abstraction occurs.
boolean	executeAbortedStep(BDIInterpreter interpreter, Object rplan) Execute a step of the plans aborted() code.
boolean	executeFailedStep(BDIInterpreter interpreter, Object rplan) Execute a step of the plans failed() code.
boolean	executePassedStep(BDIInterpreter interpreter, Object rplan) Execute a step of the plans passed() code.
boolean	executePlanStep(BDIInterpreter interpreter, Object rcapability, Object rplan) Execute a step of a plan.
boolean	executeStep(BDIInterpreter interpreter, Object rcapa, Object rplan, String steptype) Execute a step of a BPMN plan.
Object	getMonitor(Object rplan) Get the monitor of a plan.
void	interruptPlanStep(Object rplan) Interrupt a plan step during execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

BpmnPlanExecutor

public BpmnPlanExecutor()

Create a new BPMN plan executor.

Method Detail

createPlanBody

public Object createPlanBody(BDIInterpreter interpreter,
                    Object rcapability,
                    Object rplan)
                      throws Exception

Create the body of a plan.

Specified by:

createPlanBody in interface IPlanExecutor

Parameters:

rplan - The rplan.

Returns:

The created body state. May throw any kind of exception, when the body creation fails

Throws:

Exception

executeStep

public boolean executeStep(BDIInterpreter interpreter,
                  Object rcapa,
                  Object rplan,
                  String steptype)
                    throws Exception

Execute a step of a BPMN plan. Executing a step should cause the latest event to be handled. Will be called by the scheduler for every event to be handled. May throw any kind of exception, when the plan execution fails

Returns:

True, if the plan step was interrupted (interrupted flag).

Throws:

Exception

executePlanStep

public boolean executePlanStep(BDIInterpreter interpreter,
                      Object rcapability,
                      Object rplan)
                        throws Exception

Execute a step of a plan. Executing a step should cause the latest event to be handled. Will be called by the scheduler for every event to be handled. May throw any kind of exception, when the plan execution fails

Specified by:

executePlanStep in interface IPlanExecutor

Returns:

True, if plan was interrupted (micro plan step).

Throws:

Exception

executePassedStep

public boolean executePassedStep(BDIInterpreter interpreter,
                        Object rplan)
                          throws Exception

Execute a step of the plans passed() code. This method is called, after the plan has finished successfully (i.e. without exception). Will be called by the scheduler for the first time and every subsequent event to be handled. May throw any kind of exception, when the execution fails

Specified by:

executePassedStep in interface IPlanExecutor

Returns:

True, if execution was interrupted (micro plan step).

Throws:

Exception

executeFailedStep

public boolean executeFailedStep(BDIInterpreter interpreter,
                        Object rplan)
                          throws Exception

Execute a step of the plans failed() code. This method is called, when the plan has failed (i.e. due to an exception occurring in the plan body). Will be called by the scheduler for the first time and every subsequent event to be handled. May throw any kind of exception, when the execution fails

Specified by:

executeFailedStep in interface IPlanExecutor

Returns:

True, if execution was interrupted (micro plan step).

Throws:

Exception

executeAbortedStep

public boolean executeAbortedStep(BDIInterpreter interpreter,
                         Object rplan)
                           throws Exception

Execute a step of the plans aborted() code. This method is called, when the plan is terminated from the outside (e.g. when the corresponding goal is dropped or the context condition of the plan becomes invalid) Will be called by the scheduler for the first time and every subsequent event to be handled. May throw any kind of exception, when the execution fails

Specified by:

executeAbortedStep in interface IPlanExecutor

Returns:

True, if execution was interrupted (micro plan step).

Throws:

Exception

interruptPlanStep

public void interruptPlanStep(Object rplan)

Interrupt a plan step during execution. The plan is requested to stop the execution to allow consequences of performed plan actions (like belief changes) taking place. If the method is not implemented the plan step will be NOT be interrupted.

Specified by:

interruptPlanStep in interface IPlanExecutor

Parameters:

rplan - The plan handle.

eventWaitFor

public void eventWaitFor(BDIInterpreter interpreter,
                Object rplan)

Block a plan until an event matching the wait abstraction occurs. Only used for standard plans, which block during execution.

Specified by:

eventWaitFor in interface IPlanExecutor

cleanup

public void cleanup(BDIInterpreter interpreter,
           Object rplan)

Called on termination of a plan. Free all associated ressources, stop threads, etc.

Specified by:

cleanup in interface IPlanExecutor

getMonitor

public Object getMonitor(Object rplan)

Get the monitor of a plan.

Specified by:

getMonitor in interface IPlanExecutor

Returns:

The monitor.