org.jboss.shrinkwrap.descriptor.api.ejbjar30
Interface EjbRelationType<T>

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

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

This interface defines the contract for the ejb-relationType xsd type

Original Documentation:



The ejb-relationType describes a relationship between two
entity beans with container-managed persistence. It is used
by ejb-relation elements. It contains a description; an
optional ejb-relation-name element; and exactly two
relationship role declarations, defined by the
ejb-relationship-role elements. The name of the
relationship, if specified, is unique within the ejb-jar
file.


Since:
Generation date :2011-07-19T22:54:35.59+02:00
Author:
Ralf Battenfeld

Method Summary
 EjbRelationshipRoleType<EjbRelationType<T>> ejbRelationshipRole()
          If not already created, a new ejb-relationship-role element will be created and returned.
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.lang.String getEjbRelationName()
          Returns the ejb-relation-name element
 EjbRelationType<T> removeAllDescription()
          Removes the description element
 EjbRelationType<T> removeEjbRelationName()
          Removes the ejb-relation-name element
 EjbRelationType<T> removeEjbRelationshipRole()
          Removes the ejb-relationship-role element
 EjbRelationType<T> setDescription(java.lang.String description)
          Creates a new description element
 EjbRelationType<T> setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 EjbRelationType<T> setEjbRelationName(java.lang.String ejbRelationName)
          If not already created, a new ejb-relation-name element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setDescription

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

Returns:
the current instance of EjbRelationType

setDescriptionList

EjbRelationType<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 EjbRelationType

removeAllDescription

EjbRelationType<T> removeAllDescription()
Removes the description element

Returns:
the current instance of EjbRelationType

getDescriptionList

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

Returns:
list of description

setEjbRelationName

EjbRelationType<T> setEjbRelationName(java.lang.String ejbRelationName)
If not already created, a new ejb-relation-name element with the given value will be created. Otherwise, the existing ejb-relation-name element will be updated with the given value.

Returns:
the current instance of EjbRelationType

removeEjbRelationName

EjbRelationType<T> removeEjbRelationName()
Removes the ejb-relation-name element

Returns:
the current instance of EjbRelationType

getEjbRelationName

java.lang.String getEjbRelationName()
Returns the ejb-relation-name element

Returns:
the node defined for the element ejb-relation-name

removeEjbRelationshipRole

EjbRelationType<T> removeEjbRelationshipRole()
Removes the ejb-relationship-role element

Returns:
the current instance of EjbRelationType

ejbRelationshipRole

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

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