org.jboss.shrinkwrap.descriptor.api.ejbjar31
Interface EjbRelationshipRoleType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
EjbRelationshipRoleTypeImpl

public interface EjbRelationshipRoleType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the ejb-relationship-roleType xsd type

Original Documentation:


[
The ejb-relationship-roleType describes a role within a
relationship. There are two roles in each relationship.

The ejb-relationship-roleType 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 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
the entity bean that participates in the relationship is
"not aware" of the relationship.

Example:


Product-LineItem

product-has-lineitems

One

ProductEJB






Since:
Generation date :2011-07-19T22:55:02.759+02:00
Author:
Ralf Battenfeld

Method Summary
 EjbRelationshipRoleType<T> cascadeDelete()
           
 CmrFieldType<EjbRelationshipRoleType<T>> cmrField()
          If not already created, a new cmr-field element will be created and returned.
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.lang.String getEjbRelationshipRoleName()
          Returns the ejb-relationship-role-name element
 MultiplicityType getMultiplicity()
          Returns the multiplicity element
 java.lang.String getMultiplicityAsString()
          Returns the multiplicity element
 java.lang.Boolean isCascadeDelete()
           
 RelationshipRoleSourceType<EjbRelationshipRoleType<T>> relationshipRoleSource()
          If not already created, a new relationship-role-source element will be created and returned.
 EjbRelationshipRoleType<T> removeAllDescription()
          Removes the description element
 EjbRelationshipRoleType<T> removeCmrField()
          Removes the cmr-field element
 EjbRelationshipRoleType<T> removeEjbRelationshipRoleName()
          Removes the ejb-relationship-role-name element
 EjbRelationshipRoleType<T> removeRelationshipRoleSource()
          Removes the relationship-role-source element
 EjbRelationshipRoleType<T> setDescription(java.lang.String description)
          Creates a new description element
 EjbRelationshipRoleType<T> setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 EjbRelationshipRoleType<T> setEjbRelationshipRoleName(java.lang.String ejbRelationshipRoleName)
          If not already created, a new ejb-relationship-role-name element with the given value will be created.
 EjbRelationshipRoleType<T> setMultiplicity(MultiplicityType multiplicity)
          If not already created, a new multiplicity element with the given value will be created.
 EjbRelationshipRoleType<T> setMultiplicity(java.lang.String multiplicity)
          If not already created, a new multiplicity element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setDescription

EjbRelationshipRoleType<T> setDescription(java.lang.String description)
Creates a new description element

Returns:
the current instance of EjbRelationshipRoleType

setDescriptionList

EjbRelationshipRoleType<T> setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements, a new description element

Parameters:
list - of description objects
Returns:
the current instance of EjbRelationshipRoleType

removeAllDescription

EjbRelationshipRoleType<T> removeAllDescription()
Removes the description element

Returns:
the current instance of EjbRelationshipRoleType

getDescriptionList

java.util.List<java.lang.String> getDescriptionList()
Returns all description elements

Returns:
list of description

setEjbRelationshipRoleName

EjbRelationshipRoleType<T> setEjbRelationshipRoleName(java.lang.String ejbRelationshipRoleName)
If not already created, a new ejb-relationship-role-name element with the given value will be created. Otherwise, the existing ejb-relationship-role-name element will be updated with the given value.

Returns:
the current instance of EjbRelationshipRoleType

removeEjbRelationshipRoleName

EjbRelationshipRoleType<T> removeEjbRelationshipRoleName()
Removes the ejb-relationship-role-name element

Returns:
the current instance of EjbRelationshipRoleType

getEjbRelationshipRoleName

java.lang.String getEjbRelationshipRoleName()
Returns the ejb-relationship-role-name element

Returns:
the node defined for the element ejb-relationship-role-name

setMultiplicity

EjbRelationshipRoleType<T> setMultiplicity(MultiplicityType multiplicity)
If not already created, a new multiplicity element with the given value will be created. Otherwise, the existing multiplicity element will be updated with the given value.

Returns:
the current instance of EjbRelationshipRoleType

setMultiplicity

EjbRelationshipRoleType<T> setMultiplicity(java.lang.String multiplicity)
If not already created, a new multiplicity element with the given value will be created. Otherwise, the existing multiplicity element will be updated with the given value.

Returns:
the current instance of EjbRelationshipRoleType

getMultiplicity

MultiplicityType getMultiplicity()
Returns the multiplicity element

Returns:
the node defined for the element multiplicity

getMultiplicityAsString

java.lang.String getMultiplicityAsString()
Returns the multiplicity element

Returns:
the node defined for the element multiplicity

cascadeDelete

EjbRelationshipRoleType<T> cascadeDelete()

isCascadeDelete

java.lang.Boolean isCascadeDelete()

removeRelationshipRoleSource

EjbRelationshipRoleType<T> removeRelationshipRoleSource()
Removes the relationship-role-source element

Returns:
the current instance of EjbRelationshipRoleType

relationshipRoleSource

RelationshipRoleSourceType<EjbRelationshipRoleType<T>> relationshipRoleSource()
If not already created, a new relationship-role-source element will be created and returned. Otherwise, the existing relationship-role-source element will be returned.

Returns:
the node defined for the element relationship-role-source

removeCmrField

EjbRelationshipRoleType<T> removeCmrField()
Removes the cmr-field element

Returns:
the current instance of EjbRelationshipRoleType

cmrField

CmrFieldType<EjbRelationshipRoleType<T>> cmrField()
If not already created, a new cmr-field element will be created and returned. Otherwise, the existing cmr-field element will be returned.

Returns:
the node defined for the element cmr-field