|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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()
|
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.jst.j2ee.ejb.CommonRelationshipRole |
---|
getAttributes, getCommonRelationship, getOppositeAsCommonRole, getTargetAttributeName, getTypeEntity, isRequired, setLower, setUpper |
Method Detail |
public java.lang.String getLogicalName()
public EJBRelationshipRole getOpposite()
public java.lang.String getName()
CommonRelationshipRole
getName
in interface CommonRelationshipRole
public ContainerManagedEntity getSourceEntity()
getSourceEntity
in interface CommonRelationshipRole
public boolean isForward()
isForward
in interface CommonRelationshipRole
public boolean isMany()
isMany
in interface CommonRelationshipRole
public boolean isNavigable()
isNavigable
in interface CommonRelationshipRole
public void setFoward()
public void setName(java.lang.String uniqueName)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
value
- The new value of the Description attributepublic java.lang.String getRoleName()
CommonRelationshipRole
getName()
for the name to use in code
generation.
getRoleName
in interface CommonRelationshipRole
public void setRoleName(java.lang.String value)
value
- The new value of the RoleName attributepublic MultiplicityKind 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()
public void setMultiplicity(MultiplicityKind value)
Multiplicity
' attribute.
value
- the new value of the 'Multiplicity' attribute.MultiplicityKind
,
isSetMultiplicity()
,
unsetMultiplicity()
,
getMultiplicity()
public void unsetMultiplicity()
Multiplicity
' attribute.
isSetMultiplicity()
,
getMultiplicity()
,
setMultiplicity(MultiplicityKind)
public boolean isSetMultiplicity()
Multiplicity
' attribute is set.
unsetMultiplicity()
,
getMultiplicity()
,
setMultiplicity(MultiplicityKind)
public boolean isCascadeDelete()
public void setCascadeDelete(boolean value)
value
- The new value of the CascadeDelete attributepublic void unsetCascadeDelete()
Cascade Delete
' attribute.
isSetCascadeDelete()
,
isCascadeDelete()
,
setCascadeDelete(boolean)
public boolean isSetCascadeDelete()
Cascade Delete
' attribute is set.
unsetCascadeDelete()
,
isCascadeDelete()
,
setCascadeDelete(boolean)
public EJBRelation getRelationship()
public void setRelationship(EJBRelation value)
public void setRequired(java.lang.Boolean isRequired)
public RoleSource getSource()
public void setSource(RoleSource value)
public CMRField getCmrField()
public void setCmrField(CMRField value)
public 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()
public boolean isKey()
isKey
in interface CommonRelationshipRole
public void setKey(boolean aBoolean)
setKey
in interface CommonRelationshipRole
aBoolean
- the boolean valuepublic void reconcileAttributes()
CommonRelationshipRole
reconcileAttributes
in interface CommonRelationshipRole
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |