EJBRelationshipRole Definition

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.@invariant multiplicity != null@invariant roleSource != null@invariant Cascade delete can only be specified in an EJBRelationshipRole element in which the roleSource element specifies a dependent object class. @invariant Cascade delete can only be specified for an EJBRelationshipRole contained in an EJBrelation in which the other EJBRelationshipRole element specifies a multiplicity of One.Example:<ejb-relation> <ejb-relation-name>Product-LineItem</ejb-relation-name> <ejb-relationship-role> <ejb-relationship-role-name>product-has-lineitems</ejb-relationship-role-name> <multiplicity>One</multiplicity> <relationship-role-source> <ejb-name>ProductEJB</ejb-name> </relationship-role-source> </ejb-relationship-role>...

Attributes Summary

description The description is used by the ejb-jar file producer to provide text describing the ejb relationship role.

roleName Defines a name for a role that is unique within an ejb-relation.

multiplicity Describes the multiplicity of the role that participates in a relation.

cascadeDelete Specifies that, within a particular relationship, the lifetime of one or more entity beans is dependent upon the lifetime of another entity bean.

relationship

source Designates the source of a role that participates in a relationship.

cmrField A declaration of the CMRField, if any, by means of which the other side of the relationship is accessed from the perspective of the role source@migration EJB1.

Attribute Details

description
The description is used by the ejb-jar file producer to provide text describing the ejb relationship role.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.

Data type: String
Default value: unspecified

roleName
Defines a name for a role that is unique within an ejb-relation. Different relationships can use the same name for a role.

Data type: String
Default value: unspecified

multiplicity
Describes the multiplicity of the role that participates in a relation.The multiplicity element must be one of the two following: One Many

Data type: MultiplicityKind
Default value: unspecified
Allowed Values: One Many

cascadeDelete
Specifies that, within a particular relationship, the lifetime of one or more entity beans is dependent upon the lifetime of another entity bean. The cascade-delete element can Cascade delete can only be specified for an EJBRelationshipRole contained in an EJBrelation in which the other EJBRelationshipRole element specifies a multiplicity of One.

Data type: Boolean
Default value: unspecified

relationship

Data type:

source
Designates the source of a role that participates in a relationship. A relationship-role-source element uniquely identifies an entity bean.@migration EJB1.1: was ibmejbext::EjbRelationshipRole::sourceEJBName, but that may not be sufficient, as this can now refer to dependent class names or ejb refs

Data type: RoleSource

cmrField
A declaration of the CMRField, if any, by means of which the other side of the relationship is accessed from the perspective of the role source@migration EJB1.1: Used to be handled via ibmejbext::EjbRole::attributes list

Data type: CMRField

Attributes Summary
description	The description is used by the ejb-jar file producer to provide text describing the ejb relationship role.
roleName	Defines a name for a role that is unique within an ejb-relation.
multiplicity	Describes the multiplicity of the role that participates in a relation.
cascadeDelete	Specifies that, within a particular relationship, the lifetime of one or more entity beans is dependent upon the lifetime of another entity bean.
relationship
source	Designates the source of a role that participates in a relationship.
cmrField	A declaration of the CMRField, if any, by means of which the other side of the relationship is accessed from the perspective of the role source@migration EJB1.