org.jboss.shrinkwrap.descriptor.api.ejbjar30

Interface EjbRelationType<T>

All Superinterfaces:

Child<T>, JavaeeEjbRelationCommonType<T,EjbRelationType<T>,EjbRelationshipRoleType<EjbRelationType<T>>>

public interface EjbRelationType<T>
extends Child<T>, JavaeeEjbRelationCommonType<T,EjbRelationType<T>,EjbRelationshipRoleType<EjbRelationType<T>>>

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
EjbRelationshipRoleType<EjbRelationType<T>>	createEjbRelationshipRole() Creates a new ejb-relationship-role element
EjbRelationType<T>	description(String... values) Creates for all String objects representing description elements, a new description element
EjbRelationType<T>	ejbRelationName(String ejbRelationName) Sets the ejb-relation-name element
List<String>	getAllDescription() Returns all description elements
List<EjbRelationshipRoleType<EjbRelationType<T>>>	getAllEjbRelationshipRole() Returns all ejb-relationship-role elements
String	getEjbRelationName() Returns the ejb-relation-name element
String	getId() Returns the id attribute
EjbRelationshipRoleType<EjbRelationType<T>>	getOrCreateEjbRelationshipRole() If not already created, a new ejb-relationship-role element will be created and returned.
EjbRelationType<T>	id(String id) Sets the id attribute
EjbRelationType<T>	removeAllDescription() Removes the description element
EjbRelationType<T>	removeAllEjbRelationshipRole() Removes all ejb-relationship-role elements
EjbRelationType<T>	removeEjbRelationName() Removes the ejb-relation-name element
EjbRelationType<T>	removeId() Removes the id attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

up

Method Detail

description

EjbRelationType<T> description(String... values)

Creates for all String objects representing description elements, a new description element

Parameters:

values - list of description objects

Returns:

the current instance of EjbRelationType

getAllDescription

List<String> getAllDescription()

Returns all description elements

Returns:

list of description

removeAllDescription

EjbRelationType<T> removeAllDescription()

Removes the description element

Returns:

the current instance of EjbRelationType

ejbRelationName

EjbRelationType<T> ejbRelationName(String ejbRelationName)

Sets the ejb-relation-name element

Parameters:

ejbRelationName - the value for the element ejb-relation-name

Returns:

the current instance of EjbRelationType

getEjbRelationName

String getEjbRelationName()

Returns the ejb-relation-name element

Returns:

the node defined for the element ejb-relation-name

removeEjbRelationName

EjbRelationType<T> removeEjbRelationName()

Removes the ejb-relation-name element

Returns:

the current instance of EjbRelationType

getOrCreateEjbRelationshipRole

EjbRelationshipRoleType<EjbRelationType<T>> getOrCreateEjbRelationshipRole()

If not already created, a new ejb-relationship-role element will be created and returned. Otherwise, the first existing ejb-relationship-role element will be returned.

Returns:

the instance defined for the element ejb-relationship-role

createEjbRelationshipRole

EjbRelationshipRoleType<EjbRelationType<T>> createEjbRelationshipRole()

Creates a new ejb-relationship-role element

Returns:

the new created instance of EjbRelationshipRoleType>

getAllEjbRelationshipRole

List<EjbRelationshipRoleType<EjbRelationType<T>>> getAllEjbRelationshipRole()

Returns all ejb-relationship-role elements

Returns:

list of ejb-relationship-role

removeAllEjbRelationshipRole

EjbRelationType<T> removeAllEjbRelationshipRole()

Removes all ejb-relationship-role elements

Returns:

the current instance of EjbRelationshipRoleType>

id

EjbRelationType<T> id(String id)

Sets the id attribute

Parameters:

id - the value for the attribute id

Returns:

the current instance of EjbRelationType

getId

String getId()

Returns the id attribute

Returns:

the value defined for the attribute id

removeId

EjbRelationType<T> removeId()

Removes the id attribute

Returns:

the current instance of EjbRelationType