AbstractInitiatorPlan (Jadex Active Component Platform 4.0.258 API)

java.lang.Object
- jadex.bdiv3x.runtime.Plan
- - jadex.bdi.planlib.protocols.AbstractInitiatorPlan

Direct Known Subclasses:

CNPInitiatorPlan, DAInitiatorPlan, EAInitiatorPlan, RPQPInitiatorPlan
```
public abstract class AbstractInitiatorPlan
extends Plan
```
This plan serves as a base class for initiator plans. It automatically handles protocol cancellation when the plan is aborted.

Nested Class Summary
- Nested classes/interfaces inherited from class jadex.bdiv3x.runtime.Plan
  Plan.PlanWaitAbstraction

Field Summary
- Fields inherited from class jadex.bdiv3x.runtime.Plan
  agent, rplan

Constructor Summary

Constructors
Constructor Description

AbstractInitiatorPlan()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`aborted()`	Called when the plan is aborted, i.e., when the corresponding interaction goal is dropped.
`void`	`body()`	Initialize the plan
`protected abstract IMessageEvent`	`getInitialMessage()`	Get the initial message.
`long`	`getTimeout()`	Get the timeout.

Methods inherited from class jadex.bdiv3x.runtime.Plan
checkNotInAtomic, createExpression, createGoal, createInternalEvent, createMessageEvent, dispatchInternalEvent, dispatchSubgoal, dispatchSubgoalAndWait, dispatchSubgoalAndWait, dispatchTopLevelGoal, endAtomic, fail, fail, fail, failed, getAgent, getBeliefbase, getClock, getComponentDescription, getComponentIdentifier, getComponentName, getDispatchedElement, getEventbase, getException, getExpression, getExpressionbase, getExternalAccess, getGoalbase, getLogger, getParameter, getParameters, getParameterSet, getParameterSets, getPlanbase, getPlanElement, getReason, getRPlan, getScope, getTime, getWaitqueue, hasParameter, hasParameterSet, killAgent, passed, sendMessage, sendMessageAndWait, sendMessageAndWait, startAtomic, toString, waitFor, waitForCondition, waitForCondition, waitForCondition, waitForConditionInline, waitForConditionInline, waitForEver, waitForFactAdded, waitForFactAdded, waitForFactChanged, waitForFactChanged, waitForFactRemoved, waitForFactRemoved, waitForGoalFinished, waitForGoalFinished, waitForGoalFinished, waitForGoalFinished, waitForInternalEvent, waitForInternalEvent, waitForMessageEvent, waitForMessageEvent, waitForReply, waitForReply, waitForReply, waitForReply, waitForTick

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

- Constructor Detail
  - AbstractInitiatorPlan
```
public AbstractInitiatorPlan()
```
- Method Detail
  - body
```
public void body()
```
    Initialize the plan
    
    Specified by:
    
    body in class Plan
  - getTimeout
```
public long getTimeout()
```
    Get the timeout.
  - aborted
```
public void aborted()
```
    Called when the plan is aborted, i.e., when the corresponding interaction goal is dropped. Terminates the interaction using the FIPA-Cancel-Meta-Protocol.
    
    Overrides:
    
    aborted in class Plan
  - getInitialMessage
```
protected abstract IMessageEvent getInitialMessage()
```
    Get the initial message. Has to be provided by subclasses. Needed for sending cancel message in correct conversation.