jadex.bdiv3.runtime.impl

Class RFinishableElement

java.lang.Object

jadex.bdiv3.runtime.impl.RElement

jadex.bdiv3.runtime.impl.RParameterElement

jadex.bdiv3.runtime.impl.RProcessableElement

jadex.bdiv3.runtime.impl.RFinishableElement

All Implemented Interfaces:

IElement, IFinishableElement<java.lang.Void>, IParameterElement, jadex.javaparser.IMapAccess

Direct Known Subclasses:

RGoal, RServiceCall

public abstract class RFinishableElement
extends RProcessableElement
implements IFinishableElement<java.lang.Void>

Element that can be finished with processing.

Nested Class Summary

Nested classes/interfaces inherited from class jadex.bdiv3.runtime.impl.RProcessableElement

RProcessableElement.State

Nested classes/interfaces inherited from class jadex.bdiv3.runtime.impl.RParameterElement

RParameterElement.RParameter, RParameterElement.RParameterSet

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Exception	exception The exception.
protected java.util.List<jadex.commons.future.IResultListener<java.lang.Void>>	listeners The listeners.

Fields inherited from class jadex.bdiv3.runtime.impl.RProcessableElement

apl, pojoelement, state, triedplans

Fields inherited from class jadex.bdiv3.runtime.impl.RParameterElement

parameters, parametersets

Fields inherited from class jadex.bdiv3.runtime.impl.RElement

agent, cnt, id, modelelement

Constructor Summary

Constructors

Constructor and Description
RFinishableElement(MProcessableElement modelelement, java.lang.Object pojoelement, jadex.bridge.IInternalAccess agent, java.util.Map<java.lang.String,java.lang.Object> vals, MConfigParameterElement config) Create a new element.

Method Summary

Modifier and Type	Method and Description
void	addListener(jadex.commons.future.IResultListener<java.lang.Void> listener) Add a new listener to get notified when the goal is finished.
java.lang.Exception	getException() Get the exception.
java.util.List<jadex.commons.future.IResultListener<java.lang.Void>>	getListeners() Get the listeners.
abstract boolean	isFailed() Test if element is failed.
boolean	isFinished() Test if goal is finished.
abstract boolean	isSucceeded() Test if element is succeeded.
void	notifyListeners() Notify the listeners.
void	removeListener(jadex.commons.future.IResultListener<java.lang.Void> listener) Remove a listener.
void	setException(java.lang.Exception exception) Set the exception.

Methods inherited from class jadex.bdiv3.runtime.impl.RProcessableElement

addTriedPlan, getApplicablePlanList, getPojoElement, getState, getTriedPlans, planFinished, setApplicablePlanList, setPojoElement, setState, setState, setTriedPlans, testWriteOK

Methods inherited from class jadex.bdiv3.runtime.impl.RParameterElement

addParameter, addParameterSet, createParameter, createParameter, createParameterSet, createParameterSet, get, getFetcherName, getParameter, getParameters, getParameterSet, getParameterSets, getType, hasParameter, hasParameterSet, initParameters, wrapFetcher

Methods inherited from class jadex.bdiv3.runtime.impl.RElement

getAgent, getCapability, getId, getMCapability, getModelElement, getRuleSystem, setId, setModelElement, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.bdiv3x.runtime.IElement

getModelElement

Field Detail

exception

protected java.lang.Exception exception

The exception.

listeners

protected java.util.List<jadex.commons.future.IResultListener<java.lang.Void>> listeners

The listeners.

Constructor Detail

RFinishableElement

public RFinishableElement(MProcessableElement modelelement,
                          java.lang.Object pojoelement,
                          jadex.bridge.IInternalAccess agent,
                          java.util.Map<java.lang.String,java.lang.Object> vals,
                          MConfigParameterElement config)

Create a new element.

Method Detail

addListener

public void addListener(jadex.commons.future.IResultListener<java.lang.Void> listener)

Add a new listener to get notified when the goal is finished.

Specified by:

addListener in interface IFinishableElement<java.lang.Void>

Parameters:

listener - The listener.

removeListener

public void removeListener(jadex.commons.future.IResultListener<java.lang.Void> listener)

Remove a listener.

Specified by:

removeListener in interface IFinishableElement<java.lang.Void>

Parameters:

listener - The listener.

getListeners

public java.util.List<jadex.commons.future.IResultListener<java.lang.Void>> getListeners()

Get the listeners.

Returns:

The listeners.

getException

public java.lang.Exception getException()

Get the exception.

Specified by:

getException in interface IFinishableElement<java.lang.Void>

Returns:

The exception.

setException

public void setException(java.lang.Exception exception)

Set the exception.

Parameters:

exception - The exception to set.

notifyListeners

public void notifyListeners()

Notify the listeners.

isSucceeded

public abstract boolean isSucceeded()

Test if element is succeeded.

Specified by:

isSucceeded in interface IFinishableElement<java.lang.Void>

Returns:

True, if is succeeded.

isFailed

public abstract boolean isFailed()

Test if element is failed.

Specified by:

isFailed in interface IFinishableElement<java.lang.Void>

Returns:

True, if is failed.

isFinished

public boolean isFinished()

Test if goal is finished.

Specified by:

isFinished in interface IFinishableElement<java.lang.Void>

Returns:

True, if is finished.