jadex.bdiv3.model

Class MGoal

java.lang.Object

jadex.bdiv3.model.MElement

jadex.bdiv3.model.MProcessableElement

jadex.bdiv3.model.MClassBasedElement

jadex.bdiv3.model.MGoal

public class MGoal
extends MClassBasedElement

Goal model.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONDITION_CONTEXT Goal context condition name.
static String	CONDITION_CREATION Goal creation condition name.
static String	CONDITION_DROP Goal drop condition name.
static String	CONDITION_MAINTAIN Goal maintain condition name.
static String	CONDITION_RECUR Goal recur condition name.
static String	CONDITION_TARGET Goal target condition name.
static String	EXCLUDE_NEVER Never exclude plan candidates from apl.
static String	EXCLUDE_WHEN_FAILED Exclude failed plan candidates from apl.
static String	EXCLUDE_WHEN_SUCCEEDED Exclude succeeded plan candidates from apl.
static String	EXCLUDE_WHEN_TRIED Exclude tried plan candidates from apl.

Fields inherited from class jadex.bdiv3.model.MElement

CAPABILITY_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
MGoal(String name, String target, boolean posttoall, boolean randomselection, String excludemode, boolean retry, boolean recur, long retrydelay, long recurdelay, boolean orsuccess, boolean unique, MDeliberation deliberation, List<MParameter> parameters, Map<String,MethodInfo> spmappings, Map<String,MethodInfo> srmappings, List<ClassInfo> triggergoals) Create a new goal model element.

Method Summary

Modifier and Type	Method and Description
void	addCondition(String type, MCondition cond) Add a condition to the goal.
void	addServiceParameterMapping(String name, MethodInfo m)
void	addServiceResultMapping(String name, MethodInfo m)
Object	createPojoInstance(BDIAgentInterpreter ip, RGoal parent) Create a pojo goal instance.
Map<String,List<MCondition>>	getConditions() Get all conditions.
List<MCondition>	getConditions(String type) Get the conditions of a type.
MDeliberation	getDeliberation() Get the deliberation.
MParameter	getParameter(String name) Get a parameter by name.
List<MParameter>	getParameters() Get the parameters.
Object	getPojoResultReadAccess(ClassLoader cl) Get the pojo result access, i.e.
Object	getPojoResultWriteAccess(ClassLoader cl) Get the pojo result write access, i.e.
long	getRecurDelay() Get the retry delay.
long	getRetryDelay() Get the retry delay.
MethodInfo	getServiceParameterMapping(String name)
Map<String,MethodInfo>	getServiceParameterMappings() Get the spmappings.
MethodInfo	getServiceResultMapping(String name) Get the service result mapping.
Map<String,MethodInfo>	getServiceResultMappings() Get the srmappings.
List<ClassInfo>	getTriggerGoals() Get the triggergoals.
List<MGoal>	getTriggerMGoals(MCapability mcapa) Get the triggergoals.
boolean	hasParameter(String name) Test if goal has a parameter.
boolean	isDeclarative() Get the declarative.
boolean	isOrSuccess() Get the flag if is or success.
boolean	isRecur() Test if is recur.
boolean	isRetry() Test if is retry.
boolean	isUnique() Get the unique.
void	setOrSuccess(boolean orsuccess) Set the or success.
void	setParameters(List<MParameter> parameters) Set the parameters.
void	setTriggerGoals(List<ClassInfo> triggergoals) Set the triggergoals.
void	setUnique(boolean unique) Set the unique.

Methods inherited from class jadex.bdiv3.model.MClassBasedElement

equals, getTarget, getTargetClass, hashCode, setTarget

Methods inherited from class jadex.bdiv3.model.MProcessableElement

getExcludeMode, isPostToAll, isRandomSelection, isRebuild, setExcludeMode, setPostToAll, setRandomSelection, setRebuild

Methods inherited from class jadex.bdiv3.model.MElement

getCapabilityName, getName, setName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONDITION_CREATION

public static final String CONDITION_CREATION

Goal creation condition name.

See Also:

Constant Field Values

CONDITION_DROP

public static final String CONDITION_DROP

Goal drop condition name.

See Also:

Constant Field Values

CONDITION_TARGET

public static final String CONDITION_TARGET

Goal target condition name.

See Also:

Constant Field Values

CONDITION_MAINTAIN

public static final String CONDITION_MAINTAIN

Goal maintain condition name.

See Also:

Constant Field Values

CONDITION_CONTEXT

public static final String CONDITION_CONTEXT

Goal context condition name.

See Also:

Constant Field Values

CONDITION_RECUR

public static final String CONDITION_RECUR

Goal recur condition name.

See Also:

Constant Field Values

EXCLUDE_NEVER

public static final String EXCLUDE_NEVER

Never exclude plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_TRIED

public static final String EXCLUDE_WHEN_TRIED

Exclude tried plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_FAILED

public static final String EXCLUDE_WHEN_FAILED

Exclude failed plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_SUCCEEDED

public static final String EXCLUDE_WHEN_SUCCEEDED

Exclude succeeded plan candidates from apl.

See Also:

Constant Field Values

Constructor Detail

MGoal

public MGoal(String name,
             String target,
             boolean posttoall,
             boolean randomselection,
             String excludemode,
             boolean retry,
             boolean recur,
             long retrydelay,
             long recurdelay,
             boolean orsuccess,
             boolean unique,
             MDeliberation deliberation,
             List<MParameter> parameters,
             Map<String,MethodInfo> spmappings,
             Map<String,MethodInfo> srmappings,
             List<ClassInfo> triggergoals)

Create a new goal model element.

Method Detail

isRetry

public boolean isRetry()

Test if is retry.

Returns:

True, if is retry.

getRetryDelay

public long getRetryDelay()

Get the retry delay.

Returns:

The retry delay.

isRecur

public boolean isRecur()

Test if is recur.

Returns:

True, if is recur.

getRecurDelay

public long getRecurDelay()

Get the retry delay.

Returns:

The retry delay.

isOrSuccess

public boolean isOrSuccess()

Get the flag if is or success.

Returns:

The or success flag..

setOrSuccess

public void setOrSuccess(boolean orsuccess)

Set the or success.

Parameters:

orsuccess - The or success flag..

isUnique

public boolean isUnique()

Get the unique.

Returns:

The unique.

setUnique

public void setUnique(boolean unique)

Set the unique.

Parameters:

unique - The unique to set.

getDeliberation

public MDeliberation getDeliberation()

Get the deliberation.

Returns:

The deliberation.

isDeclarative

public boolean isDeclarative()

Get the declarative.

Returns:

The declarative.

getPojoResultReadAccess

public Object getPojoResultReadAccess(ClassLoader cl)

Get the pojo result access, i.e. the method or field annotated with @GoalResult.

getPojoResultWriteAccess

public Object getPojoResultWriteAccess(ClassLoader cl)

Get the pojo result write access, i.e. the method or field annotated with @GoalResult.

createPojoInstance

public Object createPojoInstance(BDIAgentInterpreter ip,
                                 RGoal parent)

Create a pojo goal instance.

addCondition

public void addCondition(String type,
                         MCondition cond)

Add a condition to the goal.

getConditions

public List<MCondition> getConditions(String type)

Get the conditions of a type.

getConditions

public Map<String,List<MCondition>> getConditions()

Get all conditions.

getParameters

public List<MParameter> getParameters()

Get the parameters.

Returns:

The parameters.

getParameter

public MParameter getParameter(String name)

Get a parameter by name.

hasParameter

public boolean hasParameter(String name)

Test if goal has a parameter.

setParameters

public void setParameters(List<MParameter> parameters)

Set the parameters.

Parameters:

parameters - The parameters to set.

addServiceParameterMapping

public void addServiceParameterMapping(String name,
                                       MethodInfo m)

getServiceParameterMapping

public MethodInfo getServiceParameterMapping(String name)

addServiceResultMapping

public void addServiceResultMapping(String name,
                                    MethodInfo m)

getServiceResultMapping

public MethodInfo getServiceResultMapping(String name)

Get the service result mapping.

getServiceParameterMappings

public Map<String,MethodInfo> getServiceParameterMappings()

Get the spmappings.

Returns:

The spmappings.

getServiceResultMappings

public Map<String,MethodInfo> getServiceResultMappings()

Get the srmappings.

Returns:

The srmappings.

getTriggerGoals

public List<ClassInfo> getTriggerGoals()

Get the triggergoals.

Returns:

The triggergoals.

setTriggerGoals

public void setTriggerGoals(List<ClassInfo> triggergoals)

Set the triggergoals.

Parameters:

triggergoals - The triggergoals to set.

getTriggerMGoals

public List<MGoal> getTriggerMGoals(MCapability mcapa)

Get the triggergoals.

Returns:

The triggergoals.