jadex.model
Interface IMElementReference

All Superinterfaces:

IMElement, IMReferenceableElement

All Known Subinterfaces:

IMAchieveGoalReference, IMBeliefReference, IMBeliefSetReference, IMConditionReference, IMEventReference, IMExpressionReference, IMGoalEventReference, IMGoalReference, IMInternalEventReference, IMMaintainGoalReference, IMMessageEventReference, IMMetaGoalReference, IMParameterElementReference, IMParameterReference, IMParameterSetReference, IMPerformGoalReference, IMPlanReference, IMQueryGoalReference, IMTypedElementReference, IMTypedElementSetReference

public interface IMElementReference
extends IMReferenceableElement

A reference to another element of the same type.

Field Summary

Fields inherited from interface jadex.model.IMReferenceableElement

EXPORTED_FALSE, EXPORTED_SHIELDED, EXPORTED_TRUE

Method Summary

IMReferenceableElement	getOriginalElement() Recursively resolves all references (if any).
String	getReference() Get the referenced element name.
IMReferenceableElement	getReferencedElement() Get the referenced element.
boolean	isAbstract() Is the element reference abstract (i.e. does not provide an assign-from element).
boolean	isRequired() Is an implementation of this element required.
void	setAbstract(boolean abs) Set the element reference to abstract (i.e. does not provide an assign-from element).
void	setReference(String ref) Set the referenced element name.
void	setRequired(boolean required) Set the required flag of the reference.

Methods inherited from interface jadex.model.IMReferenceableElement

createAssignTo, deleteAssignTo, getAssignToElements, getAssignTos, getExported, setExported

Methods inherited from interface jadex.model.IMElement

check, getChildren, getDescription, getEncodableRepresentation, getName, getOwner, getReport, getScope, getSystemExpressionParameters, setDescription, setName

Method Detail

isAbstract

boolean isAbstract()

Is the element reference abstract (i.e. does not provide an assign-from element).

Returns:

True, if element is abstract.

setAbstract

void setAbstract(boolean abs)

Set the element reference to abstract (i.e. does not provide an assign-from element).

Parameters:

abs - True, if element is abstract.

isRequired

boolean isRequired()

Is an implementation of this element required. For required references there must be an element in an outer capabilitythat references this element with an "assignTo". Only valid for abstract references.

Returns:

True, if element is required.

setRequired

void setRequired(boolean required)

Set the required flag of the reference. For required references there must be an element in an outer capabilitythat references this element with an "assignTo". Only valid for abstract references.

Parameters:

required - The required flag.

getReference

String getReference()

Get the referenced element name. Only for reference elements (=assignFrom element). Can null, when abstract.

Returns:

The reference.

setReference

void setReference(String ref)

Set the referenced element name. Only for reference elements (=assignFrom element). Can null, when abstract.

Parameters:

ref - The reference.

getReferencedElement

IMReferenceableElement getReferencedElement()

Get the referenced element.

Returns:

The referenced element.

getOriginalElement

IMReferenceableElement getOriginalElement()

Recursively resolves all references (if any).