|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EJBRelationshipRole
The ejb-relationship-role element describes a role within a relationship. There are two roles in each relationship. The ejb-relationship-role element contains an optional description; an optional name for the relationship role; a specification of the multiplicity of the role; an optional specification of cascade-delete functionality for the role; the role source; and a declaration of the cmr-field, if any, by means of which the other side of the relationship is accessed from the perspective of the role source. The multiplicity and relationship-role-source element are mandatory. The relationship-role-source element designates an entity-bean by means of an ejb-name element. For bidirectional relationships, both roles of a relationship must declare a relationship-role-source element that specifies a cmr-field in terms of which the relationship is accessed. The lack of a cmr-field element in an ejb-relationship-role specifies that the relationship is unidirectional in navigability and that entity bean that participates in the relationship is "not aware" of the relationship.
Method Summary | |
---|---|
CMRField |
getCmrField()
|
java.lang.String |
getDescription()
|
org.eclipse.emf.common.util.EList |
getDescriptions()
Returns the value of the 'Descriptions' containment reference list. |
java.lang.String |
getLogicalName()
|
MultiplicityKind |
getMultiplicity()
Returns the value of the 'Multiplicity' attribute. |
java.lang.String |
getName()
Defines a name for a role that is unique within an ejb-relation. |
EJBRelationshipRole |
getOpposite()
Return the other role. |
EJBRelation |
getRelationship()
|
java.lang.String |
getRoleName()
Return the actual name of this role. |
RoleSource |
getSource()
|
ContainerManagedEntity |
getSourceEntity()
|
boolean |
isCascadeDelete()
|
boolean |
isForward()
|
boolean |
isKey()
Return whether this role is part of the key of the source EJB. |
boolean |
isMany()
|
boolean |
isNavigable()
|
boolean |
isSetCascadeDelete()
Returns whether the value of the ' Cascade Delete ' attribute is set |
boolean |
isSetMultiplicity()
Returns whether the value of the ' Multiplicity ' attribute is set |
void |
reconcileAttributes()
Collects the attributes |
void |
setCascadeDelete(boolean value)
|
void |
setCmrField(CMRField value)
|
void |
setDescription(java.lang.String value)
|
void |
setFoward()
Set this role to be the forward role. |
void |
setKey(boolean aBoolean)
This allows you to set the Role as being key so it will not traverse it attributes to determine if it is key. |
void |
setMultiplicity(MultiplicityKind value)
Sets the value of the ' Multiplicity ' attribute |
void |
setName(java.lang.String uniqueName)
|
void |
setRelationship(EJBRelation value)
|
void |
setRequired(java.lang.Boolean isRequired)
|
void |
setRoleName(java.lang.String value)
|
void |
setSource(RoleSource value)
|
void |
unsetCascadeDelete()
Unsets the value of the ' Cascade Delete ' attribute |
void |
unsetMultiplicity()
Unsets the value of the ' Multiplicity ' attribute |
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.CommonRelationshipRole |
---|
getAttributes, getCommonRelationship, getOppositeAsCommonRole, getTargetAttributeName, getTypeEntity, isRequired, setLower, setUpper |
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 |
---|
java.lang.String getLogicalName()
EJBRelationshipRole getOpposite()
java.lang.String getName()
CommonRelationshipRole
getName
in interface CommonRelationshipRole
ContainerManagedEntity getSourceEntity()
getSourceEntity
in interface CommonRelationshipRole
boolean isForward()
isForward
in interface CommonRelationshipRole
boolean isMany()
isMany
in interface CommonRelationshipRole
boolean isNavigable()
isNavigable
in interface CommonRelationshipRole
void setFoward()
void setName(java.lang.String uniqueName)
java.lang.String getDescription()
void setDescription(java.lang.String value)
value
- The new value of the Description attributejava.lang.String getRoleName()
CommonRelationshipRole
getName()
for the name to use in code
generation.
getRoleName
in interface CommonRelationshipRole
void setRoleName(java.lang.String value)
value
- The new value of the RoleName attributeMultiplicityKind getMultiplicity()
MultiplicityKind
.
If the meaning of the 'Multiplicity' attribute isn't clear, there really should be more of a description here...
Describes the multiplicity of the role that participates in a relation. The multiplicity element must be one of the two following: One Many
MultiplicityKind
,
isSetMultiplicity()
,
unsetMultiplicity()
,
setMultiplicity(MultiplicityKind)
,
EjbPackage.getEJBRelationshipRole_Multiplicity()
void setMultiplicity(MultiplicityKind value)
Multiplicity
' attribute.
value
- the new value of the 'Multiplicity' attribute.MultiplicityKind
,
isSetMultiplicity()
,
unsetMultiplicity()
,
getMultiplicity()
void unsetMultiplicity()
Multiplicity
' attribute.
isSetMultiplicity()
,
getMultiplicity()
,
setMultiplicity(MultiplicityKind)
boolean isSetMultiplicity()
Multiplicity
' attribute is set.
unsetMultiplicity()
,
getMultiplicity()
,
setMultiplicity(MultiplicityKind)
boolean isCascadeDelete()
void setCascadeDelete(boolean value)
value
- The new value of the CascadeDelete attributevoid unsetCascadeDelete()
Cascade Delete
' attribute.
isSetCascadeDelete()
,
isCascadeDelete()
,
setCascadeDelete(boolean)
boolean isSetCascadeDelete()
Cascade Delete
' attribute is set.
unsetCascadeDelete()
,
isCascadeDelete()
,
setCascadeDelete(boolean)
EJBRelation getRelationship()
void setRelationship(EJBRelation value)
l
- The new value of the Relationship referencevoid setRequired(java.lang.Boolean isRequired)
RoleSource getSource()
void setSource(RoleSource value)
l
- The new value of the Source referenceCMRField getCmrField()
void setCmrField(CMRField value)
l
- The new value of the CmrField referenceorg.eclipse.emf.common.util.EList getDescriptions()
Description
.
If the meaning of the 'Descriptions' containment reference list isn't clear, there really should be more of a description here...
EjbPackage.getEJBRelationshipRole_Descriptions()
boolean isKey()
isKey
in interface CommonRelationshipRole
void setKey(boolean aBoolean)
setKey
in interface CommonRelationshipRole
aBoolean
- the boolean valuevoid reconcileAttributes()
CommonRelationshipRole
reconcileAttributes
in interface CommonRelationshipRole
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |