EJBRelationshipRole (OpenEJB :: Container

java.lang.Object
- org.apache.openejb.jee.was.v6.ejb.EJBRelationshipRole

```
public class EJBRelationshipRole
extends Object
```
Since:

J2EE1.3 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.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`cascadeDelete`
`protected List<CMRField>`	`cmrFields`
`protected String`	`description`
`protected List<Description>`	`descriptions`
`protected List<Extension>`	`extensions`
`protected String`	`href`
`protected String`	`id`
`protected Object`	`idref`
`protected String`	`label`
`protected MultiplicityEnum`	`multiplicity`
`protected String`	`roleName`
`protected List<RoleSource>`	`sources`
`protected QName`	`type`
`protected String`	`uuid`
`protected String`	`version`

Constructor Summary

Constructors
Constructor and Description

EJBRelationshipRole()

Constructors
Constructor and Description
`EJBRelationshipRole()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<CMRField>`	`getCmrFields()` Gets the value of the cmrFields property.
`String`	`getDescription()` Gets the value of the description property.
`List<Description>`	`getDescriptions()` Gets the value of the descriptions property.
`List<Extension>`	`getExtensions()` Gets the value of the extensions property.
`String`	`getHref()` Gets the value of the href property.
`String`	`getId()` Gets the value of the id property.
`Object`	`getIdref()` Gets the value of the idref property.
`String`	`getLabel()` Gets the value of the label property.
`MultiplicityEnum`	`getMultiplicity()` Gets the value of the multiplicity property.
`String`	`getRoleName()` Gets the value of the roleName property.
`List<RoleSource>`	`getSources()` Gets the value of the sources property.
`QName`	`getType()` Gets the value of the type property.
`String`	`getUuid()` Gets the value of the uuid property.
`String`	`getVersion()` Gets the value of the version property.
`Boolean`	`isCascadeDelete()` Gets the value of the cascadeDelete property.
`void`	`setCascadeDelete(Boolean value)` Sets the value of the cascadeDelete property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setHref(String value)` Sets the value of the href property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setIdref(Object value)` Sets the value of the idref property.
`void`	`setLabel(String value)` Sets the value of the label property.
`void`	`setMultiplicity(MultiplicityEnum value)` Sets the value of the multiplicity property.
`void`	`setRoleName(String value)` Sets the value of the roleName property.
`void`	`setType(QName value)` Sets the value of the type property.
`void`	`setUuid(String value)` Sets the value of the uuid property.
`void`	`setVersion(String value)` Sets the value of the version property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sources
```
protected List<RoleSource> sources
```
  - cmrFields
```
protected List<CMRField> cmrFields
```
  - descriptions
```
protected List<Description> descriptions
```
  - extensions
```
protected List<Extension> extensions
```
  - cascadeDelete
```
protected Boolean cascadeDelete
```
  - description
```
protected String description
```
  - multiplicity
```
protected MultiplicityEnum multiplicity
```
  - roleName
```
protected String roleName
```
  - id
```
protected String id
```
  - type
```
protected QName type
```
  - version
```
protected String version
```
  - href
```
protected String href
```
  - idref
```
protected Object idref
```
  - label
```
protected String label
```
  - uuid
```
protected String uuid
```
- Constructor Detail
  - EJBRelationshipRole
```
public EJBRelationshipRole()
```
- Method Detail
  - getSources
```
public List<RoleSource> getSources()
```
    Gets the value of the sources property.
    
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sources property.
    
    For example, to add a new item, do as follows:
```
 getSources().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list RoleSource
  - getCmrFields
```
public List<CMRField> getCmrFields()
```
    Gets the value of the cmrFields property.
    
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the cmrFields property.
    
    For example, to add a new item, do as follows:
```
 getCmrFields().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CMRField
  - getDescriptions
```
public List<Description> getDescriptions()
```
    Gets the value of the descriptions property.
    
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the descriptions property.
    
    For example, to add a new item, do as follows:
```
 getDescriptions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Description
  - getExtensions
```
public List<Extension> getExtensions()
```
    Gets the value of the extensions property.
    
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.
    
    For example, to add a new item, do as follows:
```
 getExtensions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Extension
  - isCascadeDelete
```
public Boolean isCascadeDelete()
```
    Gets the value of the cascadeDelete property.
    
    Returns:
    
    possible object is Boolean
  - setCascadeDelete
```
public void setCascadeDelete(Boolean value)
```
    Sets the value of the cascadeDelete property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getMultiplicity
```
public MultiplicityEnum getMultiplicity()
```
    Gets the value of the multiplicity property.
    
    Returns:
    
    possible object is MultiplicityEnum
  - setMultiplicity
```
public void setMultiplicity(MultiplicityEnum value)
```
    Sets the value of the multiplicity property.
    
    Parameters:
    
    value - allowed object is MultiplicityEnum
  - getRoleName
```
public String getRoleName()
```
    Gets the value of the roleName property.
    
    Returns:
    
    possible object is String
  - setRoleName
```
public void setRoleName(String value)
```
    Sets the value of the roleName property.
    
    Parameters:
    
    value - allowed object is String
  - getId
```
public String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public QName getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is QName
  - setType
```
public void setType(QName value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is QName
  - getVersion
```
public String getVersion()
```
    Gets the value of the version property.
    
    Returns:
    
    possible object is String
  - setVersion
```
public void setVersion(String value)
```
    Sets the value of the version property.
    
    Parameters:
    
    value - allowed object is String
  - getHref
```
public String getHref()
```
    Gets the value of the href property.
    
    Returns:
    
    possible object is String
  - setHref
```
public void setHref(String value)
```
    Sets the value of the href property.
    
    Parameters:
    
    value - allowed object is String
  - getIdref
```
public Object getIdref()
```
    Gets the value of the idref property.
    
    Returns:
    
    possible object is Object
  - setIdref
```
public void setIdref(Object value)
```
    Sets the value of the idref property.
    
    Parameters:
    
    value - allowed object is Object
  - getLabel
```
public String getLabel()
```
    Gets the value of the label property.
    
    Returns:
    
    possible object is String
  - setLabel
```
public void setLabel(String value)
```
    Sets the value of the label property.
    
    Parameters:
    
    value - allowed object is String
  - getUuid
```
public String getUuid()
```
    Gets the value of the uuid property.
    
    Returns:
    
    possible object is String
  - setUuid
```
public void setUuid(String value)
```
    Sets the value of the uuid property.
    
    Parameters:
    
    value - allowed object is String

Class EJBRelationshipRole

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sources

cmrFields

descriptions

extensions

cascadeDelete

description

multiplicity

roleName

id

type

version

href

idref

label

uuid

Constructor Detail

EJBRelationshipRole

Method Detail

getSources

getCmrFields

getDescriptions

getExtensions

isCascadeDelete

setCascadeDelete

getDescription

setDescription

getMultiplicity

setMultiplicity

getRoleName

setRoleName

getId

setId

getType

setType

getVersion

setVersion

getHref

setHref

getIdref

setIdref

getLabel

setLabel

getUuid

setUuid