CMHandlerPlan (Jadex Active Component Platform 4.0.197 API)

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

```
public class CMHandlerPlan
extends Plan
```
Receiver plan for FIPA-Cancel-Meta-Protocol. Waits for cancel message to terminate a conversation by dropping the supplied interaction goal.

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

Field Summary

Fields
Modifier and Type	Field	Description
`protected IMessageEvent`	`cancel_msg`	The cancel message (if any).
`protected java.lang.Object`	`failure_reason`	The failure reason, when cancel was not successful.

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

Constructor Summary

Constructors
Constructor Description

CMHandlerPlan()

Method Summary

All Methods Instance 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()`	The plan body.

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

- Field Detail
  - failure_reason
```
protected java.lang.Object failure_reason
```
    The failure reason, when cancel was not successful.
  - cancel_msg
```
protected IMessageEvent cancel_msg
```
    The cancel message (if any).
- Constructor Detail
  - CMHandlerPlan
```
public CMHandlerPlan()
```
- Method Detail
  - body
```
public void body()
```
    The plan body.
    
    Specified by:
    
    body in class Plan
  - aborted
```
public void aborted()
```
    Called when the plan is aborted, i.e., when the corresponding interaction goal is dropped.
    
    Overrides:
    
    aborted in class Plan