jadex.model
Interface IMElement

All Known Subinterfaces:

IMAchieveGoal, IMAchieveGoalReference, IMBase, IMBDIAgent, IMBelief, IMBeliefbase, IMBeliefReference, IMBeliefSet, IMBeliefSetReference, IMBindingCondition, IMCapability, IMCapabilityReference, IMCondition, IMConditionReference, IMDeliberation, IMElementReference, IMEvent, IMEventbase, IMEventReference, IMExpression, IMExpressionbase, IMExpressionParameter, IMExpressionReference, IMGoal, IMGoalbase, IMGoalEvent, IMGoalEventReference, IMGoalReference, IMInhibits, IMInitialBase, IMInitialBelief, IMInitialBeliefbase, IMInitialBeliefSet, IMInitialCapability, IMInitialCapabilitybase, IMInitialElement, IMInitialEventbase, IMInitialGoal, IMInitialGoalbase, IMInitialInternalEvent, IMInitialMessageEvent, IMInitialParameter, IMInitialParameterElement, IMInitialParameterSet, IMInitialPlan, IMInitialPlanbase, IMInitialReferenceableElement, IMInitialState, IMInitialStatebase, IMInternalEvent, IMInternalEventReference, IMMaintainGoal, IMMaintainGoalReference, IMMessageEvent, IMMessageEventReference, IMMetaGoal, IMMetaGoalReference, IMParameter, IMParameterElement, IMParameterElementReference, IMParameterReference, IMParameterSet, IMParameterSetReference, IMPerformGoal, IMPerformGoalReference, IMPlan, IMPlanbase, IMPlanBody, IMPlanParameter, IMPlanParameterSet, IMPlanReference, IMPlanTrigger, IMPropertybase, IMQueryGoal, IMQueryGoalReference, IMReference, IMReferenceableElement, IMReferenceParameter, IMRelevantElement, IMTrigger, IMTypedElement, IMTypedElementReference, IMTypedElementSet, IMTypedElementSetReference, IMUnique

public interface IMElement

The base interface of all model elements.

Method Summary

Report	check() Check the validity of the model.
List	getChildren() Method called on first setup run.
String	getDescription() Get the description (i.e. a natural language text) of the element.
Map	getEncodableRepresentation() Get an encodable representation.
List	getExpressionParameters() Get the expression parameters.
String	getName() Get the element name.
IMElement	getOwner() Get the owner of the element (i.e. the enclosing element).
Report	getReport() Return the last check report, or generate a new one, if the model has not yet been checked.
IMCapability	getScope() Get the elements scope, that means the capability it is contained in.
void	setDescription(String description) Set the description (i.e. a natural language text) of the element.
void	setName(String name) Set the element name.

Method Detail

getName

public String getName()

Get the element name.

Returns:

The element name.

setName

public void setName(String name)

Set the element name.

Parameters:

name - The element name.

getDescription

public String getDescription()

Get the description (i.e. a natural language text) of the element.

Returns:

The description text.

setDescription

public void setDescription(String description)

Set the description (i.e. a natural language text) of the element.

Parameters:

description - The description text.

getOwner

public IMElement getOwner()

Get the owner of the element (i.e. the enclosing element).

Returns:

The owner.

getChildren

public List getChildren()

Method called on first setup run. Overwritten in elements that have child elements.

Returns:

The list of direct child elements.

getScope

public IMCapability getScope()

Get the elements scope, that means the capability it is contained in.

Returns:

The capability.

getEncodableRepresentation

public Map getEncodableRepresentation()

Get an encodable representation.

Returns:

A map containing the relevant properties of the object.

getExpressionParameters

public List getExpressionParameters()

Get the expression parameters. If this element has no local parameters, will return the parameters of the owner, or null if the element has no owner.

check

public Report check()

Check the validity of the model. Returns a report of errors or an empty report when the model is valid.

getReport

public Report getReport()

Return the last check report, or generate a new one, if the model has not yet been checked.

See Also:

check()