Package jadex.bdiv3.runtime

Interface IPlan

All Superinterfaces:

IElement, IFinishableElement<java.lang.Object>, IParameterElement

public interface IPlan
extends IParameterElement, IFinishableElement<java.lang.Object>

User interface for plans.

Method Summary

Modifier and Type	Method	Description
IFuture<java.lang.Void>	abort()	Abort the plan.
<T,E> IFuture<E>	dispatchSubgoal(T goal)	Dispatch a goal wait for its result.
<T,E> IFuture<E>	dispatchSubgoal(T goal, long timeout)	Dispatch a goal wait for its result.
java.lang.Object	getDispatchedElement()	Get the dispatched element.
java.lang.String	getId()	Get the id.
java.lang.Object	getReason()	Get the reason.
boolean	isAborted()	Test if plan is aborted.
boolean	isPassed()	Test if plan is passed.
IFuture<java.lang.Void>	waitFor(long delay)	Wait for a delay.
<T> IFuture<ChangeInfo<T>>	waitForCollectionChange(java.lang.String belname, long timeout, IFilter<ChangeInfo<T>> filter)	Wait for a collection change.
<T> IFuture<ChangeInfo<T>>	waitForCollectionChange(java.lang.String belname, long timeout, java.lang.Object id)	Wait for a collection change.
IFuture<java.lang.Void>	waitForCondition(ICondition cond, java.lang.String[] events)	Wait for a condition.
IFuture<java.lang.Void>	waitForCondition(ICondition cond, java.lang.String[] events, long timeout)	Wait for a condition.
IFuture<ChangeInfo<?>>	waitForFactAdded(java.lang.String belname)	Wait for a fact being added to a belief.
IFuture<ChangeInfo<?>>	waitForFactAdded(java.lang.String belname, long timeout)	Wait for a fact being added to a belief.
IFuture<ChangeInfo<?>>	waitForFactAddedOrRemoved(java.lang.String belname)	Wait for a fact being added or removed to a belief.
IFuture<ChangeInfo<?>>	waitForFactAddedOrRemoved(java.lang.String belname, long timeout)	Wait for a fact being added or removed to a belief.
IFuture<ChangeInfo<?>>	waitForFactChanged(java.lang.String belname)	Wait for a fact change of a belief.
IFuture<ChangeInfo<?>>	waitForFactChanged(java.lang.String belname, long timeout)	Wait for a fact change of a belief.
IFuture<ChangeInfo<?>>	waitForFactRemoved(java.lang.String belname)	Wait for a fact being removed from a belief.
IFuture<ChangeInfo<?>>	waitForFactRemoved(java.lang.String belname, long timeout)	Wait for a fact being removed from a belief.

Methods inherited from interface jadex.bdiv3x.runtime.IElement

getModelElement

Methods inherited from interface jadex.bdiv3x.runtime.IFinishableElement

addListener, getException, isFailed, isFinished, isSucceeded, removeListener

Methods inherited from interface jadex.bdiv3x.runtime.IParameterElement

getParameter, getParameters, getParameterSet, getParameterSets, getType, hasParameter, hasParameterSet

Method Detail

getId

java.lang.String getId()

Get the id.

abort

IFuture<java.lang.Void> abort()

Abort the plan.

isPassed

boolean isPassed()

Test if plan is passed.

isAborted

boolean isAborted()

Test if plan is aborted.

getReason

java.lang.Object getReason()

Get the reason.

Returns:

The reason.

getDispatchedElement

java.lang.Object getDispatchedElement()

Get the dispatched element.

Returns:

The dispatched element.

waitFor

IFuture<java.lang.Void> waitFor(long delay)

Wait for a delay.

dispatchSubgoal

<T,E> IFuture<E> dispatchSubgoal(T goal)

Dispatch a goal wait for its result.

dispatchSubgoal

<T,E> IFuture<E> dispatchSubgoal(T goal,
                                       long timeout)

Dispatch a goal wait for its result.

waitForFactChanged

IFuture<ChangeInfo<?>> waitForFactChanged(java.lang.String belname)

Wait for a fact change of a belief.

waitForFactChanged

IFuture<ChangeInfo<?>> waitForFactChanged(java.lang.String belname,
                                          long timeout)

Wait for a fact change of a belief.

waitForFactAdded

IFuture<ChangeInfo<?>> waitForFactAdded(java.lang.String belname)

Wait for a fact being added to a belief.

waitForFactAdded

IFuture<ChangeInfo<?>> waitForFactAdded(java.lang.String belname,
                                        long timeout)

Wait for a fact being added to a belief.

waitForFactRemoved

IFuture<ChangeInfo<?>> waitForFactRemoved(java.lang.String belname)

Wait for a fact being removed from a belief.

waitForFactRemoved

IFuture<ChangeInfo<?>> waitForFactRemoved(java.lang.String belname,
                                          long timeout)

Wait for a fact being removed from a belief.

waitForFactAddedOrRemoved

IFuture<ChangeInfo<?>> waitForFactAddedOrRemoved(java.lang.String belname)

Wait for a fact being added or removed to a belief.

waitForFactAddedOrRemoved

IFuture<ChangeInfo<?>> waitForFactAddedOrRemoved(java.lang.String belname,
                                                 long timeout)

Wait for a fact being added or removed to a belief.

waitForCollectionChange

<T> IFuture<ChangeInfo<T>> waitForCollectionChange(java.lang.String belname,
                                                   long timeout,
                                                   IFilter<ChangeInfo<T>> filter)

Wait for a collection change.

waitForCollectionChange

<T> IFuture<ChangeInfo<T>> waitForCollectionChange(java.lang.String belname,
                                                   long timeout,
                                                   java.lang.Object id)

Wait for a collection change.

waitForCondition

IFuture<java.lang.Void> waitForCondition(ICondition cond,
                                         java.lang.String[] events)

Wait for a condition.

waitForCondition

IFuture<java.lang.Void> waitForCondition(ICondition cond,
                                         java.lang.String[] events,
                                         long timeout)

Wait for a condition.