org.eclipse.jst.j2ee.ejb
Interface EJBRelation

All Superinterfaces:
CommonRelationship, org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

public interface EJBRelation
extends J2EEEObject, CommonRelationship

The ejb-relation element describes a relationship between two entity beans with container managed persistence. An ejb-relation element contains a description; an optional ejb-relation-name element; and exactly two relationship role declarations, defined by the ejb-relationship-roles. The name of the relationship, if specified, is unique within the ejb-jar file.

Since:
1.0

Method Summary
 boolean containsRelationshipRole(EJBRelationshipRole aRole)
           
 java.lang.String getDescription()
           
 org.eclipse.emf.common.util.EList getDescriptions()
          Returns the value of the 'Descriptions' containment reference list.
 EJBRelationshipRole getFirstRole()
           
 java.lang.String getName()
          Returns the name of the CommonRelationship
 EJBRelationshipRole getOppositeRole(EJBRelationshipRole aRole)
          Return the other role.
 Relationships getRelationshipList()
           
 EJBRelationshipRole getRelationshipRole(java.lang.String aRoleName)
          Return the EJBRelationshipRole with the same name as aRoleName.
 org.eclipse.emf.common.util.EList getRelationshipRoles()
           
 EJBRelationshipRole getSecondRole()
           
 void setDescription(java.lang.String value)
           
 void setFoward(EJBRelationshipRole aRole)
          Set the forward role.
 void setName(java.lang.String value)
          Sets the name of the CommonRelationship
 void setRelationshipList(Relationships value)
           
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface org.eclipse.jst.j2ee.ejb.CommonRelationship
getCommonRoles, getFirstCommonRole, getSecondCommonRole
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

containsRelationshipRole

boolean containsRelationshipRole(EJBRelationshipRole aRole)

getFirstRole

EJBRelationshipRole getFirstRole()

getOppositeRole

EJBRelationshipRole getOppositeRole(EJBRelationshipRole aRole)
Return the other role.


getSecondRole

EJBRelationshipRole getSecondRole()

setFoward

void setFoward(EJBRelationshipRole aRole)
Set the forward role.


getDescription

java.lang.String getDescription()
Returns:
The value of the Description attribute The description is used by the ejb-jar file producer to provide text describing the ejb relation. The description should include any information that the ejb-jar file producer wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer). Typically, the tools used by the ejb-jar file consumer will display the description when processing the list of dependents.

setDescription

void setDescription(java.lang.String value)
Parameters:
value - The new value of the Description attribute

getName

java.lang.String getName()
Description copied from interface: CommonRelationship
Returns the name of the CommonRelationship

Specified by:
getName in interface CommonRelationship
Returns:
The value of the Name attribute The name of the relationship. If specified, must be unique within the ejb-jar file.

setName

void setName(java.lang.String value)
Description copied from interface: CommonRelationship
Sets the name of the CommonRelationship

Specified by:
setName in interface CommonRelationship
Parameters:
value - The new value of the Name attribute

getRelationshipList

Relationships getRelationshipList()
Returns:
The RelationshipList reference

setRelationshipList

void setRelationshipList(Relationships value)
Parameters:
l - The new value of the RelationshipList reference

getRelationshipRoles

org.eclipse.emf.common.util.EList getRelationshipRoles()
Returns:
The list of RelationshipRoles references A collection containing exactly two relationship roles.

getDescriptions

org.eclipse.emf.common.util.EList getDescriptions()
Returns the value of the 'Descriptions' containment reference list. The list contents are of type Description.

If the meaning of the 'Descriptions' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Descriptions' containment reference list.
See Also:
EjbPackage.getEJBRelation_Descriptions()

getRelationshipRole

EJBRelationshipRole getRelationshipRole(java.lang.String aRoleName)
Return the EJBRelationshipRole with the same name as aRoleName.