jadex.runtime
Interface IProcessGoal

All Superinterfaces:

IElement, IParameterElement

public interface IProcessGoal

extends IParameterElement

The supertype for all goals (concrete and referenced) and all goal types (perform, achieve, get, maintain).

Method Summary

void	abort() Abort this goal.
IParameter	getResultParameter() Deprecated.
String	getType() Get the goal type.
boolean	isAbortedOnSuccess() Check if the corresponding plan was aborted because the proprietary goal succeeded during the plan was running.
void	setResult(Object result) Deprecated.

Methods inherited from interface jadex.runtime.IParameterElement

getParameter, getParameters, getParameterSet, getParameterSets, hasParameter, hasParameterSet

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Method Detail

abort

public void abort()

Abort this goal. Causes the corresponding plan to be terminated and subgoals to be dropped.

isAbortedOnSuccess

public boolean isAbortedOnSuccess()

Check if the corresponding plan was aborted because the proprietary goal succeeded during the plan was running.

Returns:

True, if the goal was aborted on success of the proprietary goal.

getType

public String getType()

Get the goal type.

Returns:

The goal type.

setResult

public void setResult(Object result)

Deprecated.

Set the result for the goal. This is a convenience method, as the goal result is stored as property.

Parameters:

result - The result.

getResultParameter

public IParameter getResultParameter()

Deprecated.

Get the result parameter.

Returns:

The result parameter.