arom.kr.model
Interface Role

All Superinterfaces:

AMEntity, helix.util.beans.CompoundPropertySet, DocumentableObject, NamedEntity, helix.util.beans.PropertySet, Slot

public interface Role

extends Slot

A role is the connection between an association and one of the linked classes. The linked class is called the corresponding class of the role. This class defines the type of the role. Each n-ary association has n roles and the value of each role is an instance of the corresponding class of that role.

Author:

"Christophe Bruley"

Field Summary

Fields inherited from interface arom.kr.model.NamedEntity

NAME

Method Summary

RoleDescriptor

getRoleDescriptionFor(AMAssociation association) Returns the description of this role for the specified association.

Methods inherited from interface arom.kr.model.Slot

getDescriptionFor, getStructure

Methods inherited from interface arom.kr.model.NamedEntity

getFQName, getName, getNameSpace, setName

Methods inherited from interface arom.kr.model.AMEntity

addEntityListener, delete, getContainer, getIdentifier, removeEntityListener, verify

Methods inherited from interface arom.kr.model.DocumentableObject

applyDocumentationModifier, cancelDocumentationModifier, documentationModifiers, getDocumentation, lookupDocumentationModifier

Methods inherited from interface helix.util.beans.PropertySet

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from interface helix.util.beans.CompoundPropertySet

addCompositionChangeListener, addCompositionChangeListener, addVetoableCompositionChangeListener, addVetoableCompositionChangeListener, removeCompositionChangeListener, removeCompositionChangeListener, removeVetoableCompositionChangeListener, removeVetoableCompositionChangeListener

Method Detail

getRoleDescriptionFor

public RoleDescriptor getRoleDescriptionFor(AMAssociation association)
                                     throws NoSuchEntityException

Returns the description of this role for the specified association. This method specialize the getDescriptionFor(Structure) method from the Slot class.

Parameters:

association - an association

Returns:

the description of this role for the specified association.

Throws:

NoSuchEntityException - if this role is not contained in the specified association.