BpmnPlanBodyInstance (Jadex Active Component Platform 2.3 API.)

java.lang.Object
- jadex.kernelbase.StatelessAbstractInterpreter
- - jadex.kernelbase.AbstractInterpreter
  - - jadex.bpmn.runtime.BpmnInterpreter
    - - jadex.bdibpmn.BpmnPlanBodyInstance

All Implemented Interfaces:

IComponentInstance, IInternalAccess
```
public class BpmnPlanBodyInstance
extends BpmnInterpreter
```
A BPMN instance that is executed as a plan body.

Field Summary

Fields
Modifier and Type Field and Description

static Map PLAN_ACTIVITY_HANDLERS
The activity execution handlers (activity type -> handler).
- Fields inherited from class jadex.bpmn.runtime.BpmnInterpreter
  ALL, DEFAULT_ACTIVITY_HANDLERS, DEFAULT_STEP_HANDLERS, TYPE_ACTIVITY, TYPE_THREAD
- Fields inherited from class jadex.kernelbase.StatelessAbstractInterpreter
  TYPE_COMPONENT

Fields
Modifier and Type	Field and Description
`static Map`	`PLAN_ACTIVITY_HANDLERS` The activity execution handlers (activity type -> handler).

Constructor Summary

Constructors
Constructor and Description
`BpmnPlanBodyInstance(jadex.bpmn.model.MBpmnModel model, BDIInterpreter interpreter, Object rcapa, Object rplan)` Create a new BPMN process instance using default handler.

Method Summary

Methods
Modifier and Type	Method and Description
`IFuture`	`addComponentListener(IComponentListener listener)` Add an component listener.
`void`	`addPlanListener(IPlanListener listener)` Add a plan listener.
`void`	`addTimer(ProcessThread thread, long duration)` Add a timer for a thread.
`IExpression`	`createExpression(String expression)` Create a precompiled expression.
`IExpression`	`createExpression(String expression, String[] paramnames, Class[] paramtypes)` Create a precompiled expression.
`IGoal`	`createGoal(String type)` Create a goal from a template goal.
`IInternalEvent`	`createInternalEvent(String type)` Create a new intenal event.
`IMessageEvent`	`createMessageEvent(String type)` Create a new message event.
`IServiceContainer`	`createServiceContainer()` Service container is set from the outside.
`void`	`dispatchInternalEvent(IInternalEvent event)` Dispatch an internal event.
`void`	`dispatchSubgoal(IGoal subgoal)` Dispatch a new subgoal.
`void`	`dispatchTopLevelGoal(IGoal goal)` Dispatch a new top-level goal.
`void`	`endAtomic()` End an atomic transaction.
`void`	`fail()` Let a plan fail.
`void`	`fail(String message, Throwable cause)` Let a plan fail.
`void`	`fail(Throwable cause)` Let a plan fail.
`IComponentIdentifier`	`getAgentIdentifier()` Get the agent identifier.
`String`	`getAgentName()` Get the agent name.
`IBeliefbase`	`getBeliefbase()` Get the belief base.
`IClockService`	`getClock()` Get the clock.
`IElement`	`getDispatchedElement()` Get the dispatched element, i.e. the element that caused the current plan step being executed.
`IEventbase`	`getEventbase()` Get the event base.
`String`	`getEventParent()` Get the event parent.
`Exception`	`getException()` Get the uncatched exception that occurred in the body (if any).
`IExpression`	`getExpression(String name)` Get an instance of a predefined expression.
`IExpressionbase`	`getExpressionbase()` Get the expression base.
`IExternalAccess`	`getExternalAccess()` Get the scope.
`IGoalbase`	`getGoalbase()` Get the goal base.
`BDIInterpreter`	`getInterpreter()` Get the state.
`String`	`getLastState()` Get the last plan lifecycle state.
`Logger`	`getLogger()` Get the logger.
`IParameter`	`getParameter(String name)` Get a parameter.
`IParameter[]`	`getParameters()` Get all parameters.
`IParameterSet`	`getParameterSet(String name)` Get a parameter.
`IParameterSet[]`	`getParameterSets()` Get all parameter sets.
`IPlanbase`	`getPlanbase()` Get the plan base.
`IElement`	`getReason()` Get the reason, why the plan gets executed.
`Object`	`getRPlan()` Get the plan instance info.
`ICapability`	`getScope()` Get the scope.
`IServiceProvider`	`getServiceProvider()` Get the service provider.
`jadex.rules.state.IOAVState`	`getState()` Get the state.
`long`	`getTime()` Get the current time.
`long`	`getTimeout()` Get the current timeout of the process, i.e. the remaining time of the closest due intermediate timer event.
`Object`	`getWaitAbstraction()` Get the cumulated wait abstraction for all threads.
`IWaitqueue`	`getWaitqueue()` Get the waitqueue.
`boolean`	`hasParameter(String name)` Has the element a parameter element.
`boolean`	`hasParameterSet(String name)` Has the element a parameter set element.
`boolean`	`isExternalThread()` Delegate synchronization to agent.
`void`	`killAgent()` Kill this agent.
`void`	`notify(jadex.bpmn.model.MActivity activity, ProcessThread thread, Object event)` Delegate synchronization to agent
`IFuture`	`removeComponentListener(IComponentListener listener)` Remove a component listener.
`void`	`removePlanListener(IPlanListener listener)` Remove a plan listener.
`void`	`removeTimer(ProcessThread thread)` Remove a timer for a thread.
`IFuture`	`scheduleStep(IComponentStep step)` Schedule a step of the agent.
`IFuture`	`sendMessage(IMessageEvent me)` Send a message after some delay.
`IFuture`	`sendMessage(IMessageEvent me, byte[] codecids)` Send a message after some delay.
`void`	`setLastState(String state)` Set the plan lifecycle state.
`void`	`startAtomic()` Start an atomic transaction.
`void`	`updateWaitingThreads()` Update the waiting threads according to the wakeup reason (dispatched element).

Methods inherited from class jadex.bpmn.runtime.BpmnInterpreter
createActivityEvent, createProcessThreadInfo, createReply, createReply, createThreadEvent, executeStep, executeStep, getActivityHandler, getClassLoader, getContextVariable, getFetcher, getInternalAccess, getModelElement, getThreadContext, hasContextVariable, isAtBreakpoint, isFinished, isReady, messageArrived, setContextVariable, setContextVariable, startBehavior, startEndSteps, step, streamArrived

Methods inherited from class jadex.kernelbase.AbstractInterpreter
addArgument, addDefaultResult, addExtension, addProperty, checkAllowedThread, getArguments, getBindings, getComponentAdapter, getComponentListeners, getConfiguration, getExtension, getExtensions, getInternalComponentListeners, getModel, getParentAccess, getProperties, getResults, getServiceBindings, getServiceContainer, isCopy, isRealtime, setResultValue

Methods inherited from class jadex.kernelbase.StatelessAbstractInterpreter
addService, cleanupComponent, componentCreated, componentDestroyed, createChild, createComponent, createResultListener, createResultListener, getArguments, getChildren, getComponentDescription, getComponentFilename, getComponentIdentifier, getLocalType, getName, getName, getNumber, getProperty, getRawService, getRawService, getRawServices, getServicePrefix, init, initArguments, initComponents, initExtension, initExtensions, initFutureProperties, initServices, isComponentThread, killComponent, notifyListeners, startInitialSteps, startServiceContainer, terminateExtensions, terminateServiceContainer, toString, waitForDelay, waitForDelay

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.bridge.IInternalAccess
createResultListener, createResultListener, getArguments, getComponentDescription, getComponentIdentifier, getConfiguration, getModel, getParentAccess, getResults, getServiceContainer, isComponentThread, killComponent, setResultValue, waitForDelay, waitForDelay

- Field Detail
  - PLAN_ACTIVITY_HANDLERS
```
public static final Map PLAN_ACTIVITY_HANDLERS
```
    The activity execution handlers (activity type -> handler).
- Constructor Detail
  - BpmnPlanBodyInstance
```
public BpmnPlanBodyInstance(jadex.bpmn.model.MBpmnModel model,
                    BDIInterpreter interpreter,
                    Object rcapa,
                    Object rplan)
```
    Create a new BPMN process instance using default handler.
    
    Parameters:
    model - The BMPN process model.
- Method Detail
  - getLastState
```
public String getLastState()
```
    Get the last plan lifecycle state.
    
    Returns:
    The plan lifecycle state.
  - setLastState
```
public void setLastState(String state)
```
    Set the plan lifecycle state.
    
    Parameters:
    state - The plan lifecycle state.
  - addTimer
```
public void addTimer(ProcessThread thread,
            long duration)
```
    Add a timer for a thread.
    
    Parameters:
    thread - The process thread that should wait.
    duration - The duration to wait for.
  - removeTimer
```
public void removeTimer(ProcessThread thread)
```
    Remove a timer for a thread.
    
    Parameters:
    thread - The process thread that should wait.
    duration - The duration to wait for.
  - updateWaitingThreads
```
public void updateWaitingThreads()
```
    Update the waiting threads according to the wakeup reason (dispatched element). The corresponding waiting activity/thread is notified.
  - getTimeout
```
public long getTimeout()
```
    Get the current timeout of the process, i.e. the remaining time of the closest due intermediate timer event.
    
    Returns:
    The current timeout or -1 for no timeout.
  - getWaitAbstraction
```
public Object getWaitAbstraction()
```
    Get the cumulated wait abstraction for all threads.
    
    Returns:
    The wait abstraction.
  - fail
```
public void fail()
```
    Let a plan fail.
  - fail
```
public void fail(Throwable cause)
```
    Let a plan fail.
    
    Parameters:
    cause - The cause.
  - fail
```
public void fail(String message,
        Throwable cause)
```
    Let a plan fail.
    
    Parameters:
    message - The message.
    cause - The cause.
  - getScope
```
public ICapability getScope()
```
    Get the scope.
    
    Returns:
    The scope.
  - getReason
```
public IElement getReason()
```
    Get the reason, why the plan gets executed.
  - getDispatchedElement
```
public IElement getDispatchedElement()
```
    Get the dispatched element, i.e. the element that caused the current plan step being executed.
    
    Returns:
    The dispatched element.
  - getLogger
```
public Logger getLogger()
```
    Get the logger.
    
    Specified by:
    
    getLogger in interface IInternalAccess
    
    Overrides:
    
    getLogger in class jadex.kernelbase.StatelessAbstractInterpreter
    
    Returns:
    The logger.
  - startAtomic
```
public void startAtomic()
```
    Start an atomic transaction. All possible side-effects (i.e. triggered conditions) of internal changes (e.g. belief changes) will be delayed and evaluated after endAtomic() has been called.
    
    See Also:
    endAtomic()
  - endAtomic
```
public void endAtomic()
```
    End an atomic transaction. Side-effects (i.e. triggered conditions) of all internal changes (e.g. belief changes) performed after the last call to startAtomic() will now be evaluated and performed.
    
    See Also:
    startAtomic()
  - dispatchSubgoal
```
public void dispatchSubgoal(IGoal subgoal)
```
    Dispatch a new subgoal.
    
    Parameters:
    subgoal - The new subgoal. Note: plan step is interrupted after call.
  - getWaitqueue
```
public IWaitqueue getWaitqueue()
```
    Get the waitqueue.
    
    Returns:
    The waitqueue.
  - getAgentName
```
public String getAgentName()
```
    Get the agent name.
    
    Returns:
    The agent name.
  - getAgentIdentifier
```
public IComponentIdentifier getAgentIdentifier()
```
    Get the agent identifier.
    
    Returns:
    The agent identifier.
  - getException
```
public Exception getException()
```
    Get the uncatched exception that occurred in the body (if any). Method should only be called when in failed() method.
    
    Returns:
    The exception.
  - killAgent
```
public void killAgent()
```
    Kill this agent.
  - getBeliefbase
```
public IBeliefbase getBeliefbase()
```
    Get the belief base.
    
    Returns:
    The belief base.
  - getGoalbase
```
public IGoalbase getGoalbase()
```
    Get the goal base.
    
    Returns:
    The goal base.
  - getPlanbase
```
public IPlanbase getPlanbase()
```
    Get the plan base.
    
    Returns:
    The plan base.
  - getEventbase
```
public IEventbase getEventbase()
```
    Get the event base.
    
    Returns:
    The event base.
  - getExpressionbase
```
public IExpressionbase getExpressionbase()
```
    Get the expression base.
    
    Returns:
    The expression base.
  - getClock
```
public IClockService getClock()
```
    Get the clock.
    
    Returns:
    The clock.
  - getTime
```
public long getTime()
```
    Get the current time. The time unit depends on the currently running clock implementation. For the default system clock, the time value adheres to the time representation as used by System.currentTimeMillis(), i.e., the value of milliseconds passed since 0:00 'o clock, January 1st, 1970, UTC. For custom simulation clocks, arbitrary representations can be used.
    
    Returns:
    The current time.
  - dispatchTopLevelGoal
```
public void dispatchTopLevelGoal(IGoal goal)
```
    Dispatch a new top-level goal.
    
    Parameters:
    goal - The new goal. Note: plan step is interrupted after call.
  - createGoal
```
public IGoal createGoal(String type)
```
    Create a goal from a template goal. To be processed, the goal has to be dispatched as subgoal or adopted as top-level goal.
    
    Parameters:
    type - The template goal name as specified in the ADF.
    
    Returns:
    The created goal.
  - sendMessage
```
public IFuture sendMessage(IMessageEvent me)
```
    Send a message after some delay.
    
    Parameters:
    me - The message event.
    
    Returns:
    The filter to wait for an answer.
  - sendMessage
```
public IFuture sendMessage(IMessageEvent me,
                  byte[] codecids)
```
    Send a message after some delay.
    
    Parameters:
    me - The message event.
    
    Returns:
    The filter to wait for an answer.
  - dispatchInternalEvent
```
public void dispatchInternalEvent(IInternalEvent event)
```
    Dispatch an internal event.
    
    Parameters:
    event - The event. Note: plan step is interrupted after call.
  - createMessageEvent
```
public IMessageEvent createMessageEvent(String type)
```
    Create a new message event.
    
    Returns:
    The new message event.
  - createInternalEvent
```
public IInternalEvent createInternalEvent(String type)
```
    Create a new intenal event.
    
    Returns:
    The new intenal event.
  - getExternalAccess
```
public IExternalAccess getExternalAccess()
```
    Get the scope.
    
    Specified by:
    
    getExternalAccess in interface IComponentInstance
    
    Specified by:
    
    getExternalAccess in interface IInternalAccess
    
    Overrides:
    
    getExternalAccess in class jadex.kernelbase.AbstractInterpreter
    
    Returns:
    The scope.
  - getExpression
```
public IExpression getExpression(String name)
```
    Get an instance of a predefined expression.
    
    Parameters:
    name - The name of an expression defined in the ADF.
    
    Returns:
    The expression instance.
  - createExpression
```
public IExpression createExpression(String expression)
```
    Create a precompiled expression.
    
    Parameters:
    expression - The expression string.
    
    Returns:
    The precompiled expression.
  - createExpression
```
public IExpression createExpression(String expression,
                           String[] paramnames,
                           Class[] paramtypes)
```
    Create a precompiled expression.
    
    Parameters:
    expression - The expression string.
    
    Returns:
    The precompiled expression.
  - getParameters
```
public IParameter[] getParameters()
```
    Get all parameters.
    
    Returns:
    All parameters.
  - getParameterSets
```
public IParameterSet[] getParameterSets()
```
    Get all parameter sets.
    
    Returns:
    All parameter sets.
  - getParameter
```
public IParameter getParameter(String name)
```
    Get a parameter.
    
    Parameters:
    name - The name.
    
    Returns:
    The parameter.
  - getParameterSet
```
public IParameterSet getParameterSet(String name)
```
    Get a parameter.
    
    Parameters:
    name - The name.
    
    Returns:
    The parameter set.
  - hasParameter
```
public boolean hasParameter(String name)
```
    Has the element a parameter element.
    
    Parameters:
    name - The name.
    
    Returns:
    True, if it has the parameter.
  - hasParameterSet
```
public boolean hasParameterSet(String name)
```
    Has the element a parameter set element.
    
    Parameters:
    name - The name.
    
    Returns:
    True, if it has the parameter set.
  - getState
```
public jadex.rules.state.IOAVState getState()
```
    Get the state.
    
    Returns:
    The state.
  - getInterpreter
```
public BDIInterpreter getInterpreter()
```
    Get the state.
    
    Returns:
    The state.
  - getEventParent
```
public String getEventParent()
```
    Get the event parent.
    
    Returns:
    The event parent.
  - getRPlan
```
public Object getRPlan()
```
    Get the plan instance info.
    
    Returns:
    The plan instance info.
  - addPlanListener
```
public void addPlanListener(IPlanListener listener)
```
    Add a plan listener.
    
    Parameters:
    listener - The plan listener.
  - removePlanListener
```
public void removePlanListener(IPlanListener listener)
```
    Remove a plan listener.
    
    Parameters:
    listener - The plan listener.
  - notify
```
public void notify(jadex.bpmn.model.MActivity activity,
          ProcessThread thread,
          Object event)
```
    Delegate synchronization to agent. / public void invokeLater(final Runnable action) { // Redirect to component instance. interpreter.invokeLater(action); // Called from outside (e.g. workflow client) // when task is finished // Check if plan should be set to ready (Hack!!!) // interpreter.invokeLater(new Runnable() // { // public void run() // { // // The DefaultActivityHandler.step() may rethrow an exception that // // occurred within task execution. // // It is catched an stored in the plan to be rethrown from the // // BPMNPlanExecutor.executeStep() method. // // The plan must always be set to ready to transfer the state // // of the process thread to the plan. // try // { // action.run(); // } // catch(Throwable t) // { // state.setAttributeValue(rplan, OAVBDIRuntimeModel.plan_has_exception, t); // } // state.setAttributeValue(rplan, OAVBDIRuntimeModel.plan_has_processingstate, OAVBDIRuntimeModel.PLANPROCESSINGTATE_READY); // //// String lane = getLane(getLastState()); //// if(isReady(null, lane)) //// { //// state.setAttributeValue(rplan, OAVBDIRuntimeModel.plan_has_processingstate, OAVBDIRuntimeModel.PLANPROCESSINGTATE_READY); //// } // } // }); } /** Method that should be called, when an activity is finished and the following activity should be scheduled. Can safely be called from external threads.
    
    Overrides:
    
    notify in class BpmnInterpreter
    
    Parameters:
    activity - The timing event activity.
    instance - The process instance.
    thread - The process thread.
    event - The event that has occurred, if any.
  - isExternalThread
```
public boolean isExternalThread()
```
    Delegate synchronization to agent.
    
    Specified by:
    
    isExternalThread in interface IComponentInstance
    
    Overrides:
    
    isExternalThread in class jadex.kernelbase.StatelessAbstractInterpreter
    
    Returns:
    True, if called from an external (i.e. non-synchronized) thread.
  - scheduleStep
```
public IFuture scheduleStep(IComponentStep step)
```
    Schedule a step of the agent. May safely be called from external threads.
    
    Overrides:
    
    scheduleStep in class BpmnInterpreter
    
    Parameters:
    step - Code to be executed as a step of the agent.
    
    Returns:
    The result of the step.
  - getServiceProvider
```
public IServiceProvider getServiceProvider()
```
    Get the service provider.
    
    Overrides:
    
    getServiceProvider in class jadex.kernelbase.StatelessAbstractInterpreter
    
    Returns:
    The service provider.
  - addComponentListener
```
public IFuture addComponentListener(IComponentListener listener)
```
    Add an component listener.
    
    Specified by:
    
    addComponentListener in interface IInternalAccess
    
    Overrides:
    
    addComponentListener in class jadex.kernelbase.AbstractInterpreter
    
    Parameters:
    listener - The listener.
  - removeComponentListener
```
public IFuture removeComponentListener(IComponentListener listener)
```
    Remove a component listener.
    
    Specified by:
    
    removeComponentListener in interface IInternalAccess
    
    Overrides:
    
    removeComponentListener in class jadex.kernelbase.AbstractInterpreter
    
    Parameters:
    listener - The listener.
  - createServiceContainer
```
public IServiceContainer createServiceContainer()
```
    Service container is set from the outside.
    
    Overrides:
    
    createServiceContainer in class jadex.kernelbase.AbstractInterpreter

Class BpmnPlanBodyInstance

Field Summary

Fields inherited from class jadex.bpmn.runtime.BpmnInterpreter

Fields inherited from class jadex.kernelbase.StatelessAbstractInterpreter

Constructor Summary

Method Summary

Methods inherited from class jadex.bpmn.runtime.BpmnInterpreter

Methods inherited from class jadex.kernelbase.AbstractInterpreter

Methods inherited from class jadex.kernelbase.StatelessAbstractInterpreter

Methods inherited from class java.lang.Object

Methods inherited from interface jadex.bridge.IInternalAccess

Field Detail

PLAN_ACTIVITY_HANDLERS

Constructor Detail

BpmnPlanBodyInstance

Method Detail

getLastState

setLastState

addTimer

removeTimer

updateWaitingThreads

getTimeout

getWaitAbstraction

fail

fail

fail

getScope

getReason

getDispatchedElement

getLogger

startAtomic

endAtomic

dispatchSubgoal

getWaitqueue

getAgentName

getAgentIdentifier

getException

killAgent

getBeliefbase

getGoalbase

getPlanbase

getEventbase

getExpressionbase

getClock

getTime

dispatchTopLevelGoal

createGoal

sendMessage

sendMessage

dispatchInternalEvent

createMessageEvent

createInternalEvent

getExternalAccess

getExpression

createExpression

createExpression

getParameters

getParameterSets

getParameter

getParameterSet

hasParameter

hasParameterSet

getState

getInterpreter

getEventParent

getRPlan

addPlanListener

removePlanListener

notify

isExternalThread

scheduleStep

getServiceProvider

addComponentListener

removeComponentListener

createServiceContainer