org.jboss.shrinkwrap.descriptor.api.javaee5
Interface EjbLocalRefType<T>

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

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

This interface defines the contract for the ejb-local-refType xsd type

Original Documentation:



The ejb-local-refType is used by ejb-local-ref elements for
the declaration of a reference to an enterprise bean's local
home or to the local business interface of a 3.0 bean.
The declaration consists of:

- an optional description
- the EJB reference name used in the code of the Deployment
Component that's referencing the enterprise bean.
- the optional expected type of the referenced enterprise bean
- the optional expected local interface of the referenced
enterprise bean or the local business interface of the
referenced enterprise bean.
- the optional expected local home interface of the referenced
enterprise bean. Not applicable if this ejb-local-ref refers
to the local business interface of a 3.0 bean.
- optional ejb-link information, used to specify the
referenced enterprise bean
- optional elements to define injection of the named enterprise
bean into a component field or property.


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

Method Summary
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.lang.String getEjbLink()
          Returns the ejb-link element
 java.lang.String getEjbRefName()
          Returns the ejb-ref-name element
 EjbRefTypeType getEjbRefType()
          Returns the ejb-ref-type element
 java.lang.String getEjbRefTypeAsString()
          Returns the ejb-ref-type element
 java.util.List<InjectionTargetType<EjbLocalRefType<T>>> getInjectionTargetList()
          Returns all injection-target elements
 java.lang.String getLocal()
          Returns the local element
 java.lang.String getLocalHome()
          Returns the local-home element
 java.lang.String getMappedName()
          Returns the mapped-name element
 InjectionTargetType<EjbLocalRefType<T>> injectionTarget()
          Returns the injection-target element
 EjbLocalRefType<T> removeAllDescription()
          Removes the description element
 EjbLocalRefType<T> removeAllInjectionTarget()
          Removes all injection-target elements
 EjbLocalRefType<T> removeEjbLink()
          Removes the ejb-link element
 EjbLocalRefType<T> removeEjbRefName()
          Removes the ejb-ref-name element
 EjbLocalRefType<T> removeLocal()
          Removes the local element
 EjbLocalRefType<T> removeLocalHome()
          Removes the local-home element
 EjbLocalRefType<T> removeMappedName()
          Removes the mapped-name element
 EjbLocalRefType<T> setDescription(java.lang.String description)
          Creates a new description element
 EjbLocalRefType<T> setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 EjbLocalRefType<T> setEjbLink(java.lang.String ejbLink)
          If not already created, a new ejb-link element with the given value will be created.
 EjbLocalRefType<T> setEjbRefName(java.lang.String ejbRefName)
          If not already created, a new ejb-ref-name element with the given value will be created.
 EjbLocalRefType<T> setEjbRefType(EjbRefTypeType ejbRefType)
          If not already created, a new ejb-ref-type element with the given value will be created.
 EjbLocalRefType<T> setEjbRefType(java.lang.String ejbRefType)
          If not already created, a new ejb-ref-type element with the given value will be created.
 EjbLocalRefType<T> setLocal(java.lang.String local)
          If not already created, a new local element with the given value will be created.
 EjbLocalRefType<T> setLocalHome(java.lang.String localHome)
          If not already created, a new local-home element with the given value will be created.
 EjbLocalRefType<T> setMappedName(java.lang.String mappedName)
          If not already created, a new mapped-name element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setMappedName

EjbLocalRefType<T> setMappedName(java.lang.String mappedName)
If not already created, a new mapped-name element with the given value will be created. Otherwise, the existing mapped-name element will be updated with the given value.

Returns:
the current instance of EjbLocalRefType

removeMappedName

EjbLocalRefType<T> removeMappedName()
Removes the mapped-name element

Returns:
the current instance of EjbLocalRefType

getMappedName

java.lang.String getMappedName()
Returns the mapped-name element

Returns:
the node defined for the element mapped-name

removeAllInjectionTarget

EjbLocalRefType<T> removeAllInjectionTarget()
Removes all injection-target elements

Returns:
the current instance of EjbLocalRefType

injectionTarget

InjectionTargetType<EjbLocalRefType<T>> injectionTarget()
Returns the injection-target element

Returns:
the node defined for the element injection-target

getInjectionTargetList

java.util.List<InjectionTargetType<EjbLocalRefType<T>>> getInjectionTargetList()
Returns all injection-target elements

Returns:
list of injection-target

setDescription

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

Returns:
the current instance of EjbLocalRefType

setDescriptionList

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

removeAllDescription

EjbLocalRefType<T> removeAllDescription()
Removes the description element

Returns:
the current instance of EjbLocalRefType

getDescriptionList

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

Returns:
list of description

setEjbRefName

EjbLocalRefType<T> setEjbRefName(java.lang.String ejbRefName)
If not already created, a new ejb-ref-name element with the given value will be created. Otherwise, the existing ejb-ref-name element will be updated with the given value.

Returns:
the current instance of EjbLocalRefType

removeEjbRefName

EjbLocalRefType<T> removeEjbRefName()
Removes the ejb-ref-name element

Returns:
the current instance of EjbLocalRefType

getEjbRefName

java.lang.String getEjbRefName()
Returns the ejb-ref-name element

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

setEjbRefType

EjbLocalRefType<T> setEjbRefType(EjbRefTypeType ejbRefType)
If not already created, a new ejb-ref-type element with the given value will be created. Otherwise, the existing ejb-ref-type element will be updated with the given value.

Returns:
the current instance of EjbLocalRefType

setEjbRefType

EjbLocalRefType<T> setEjbRefType(java.lang.String ejbRefType)
If not already created, a new ejb-ref-type element with the given value will be created. Otherwise, the existing ejb-ref-type element will be updated with the given value.

Returns:
the current instance of EjbLocalRefType

getEjbRefType

EjbRefTypeType getEjbRefType()
Returns the ejb-ref-type element

Returns:
the node defined for the element ejb-ref-type

getEjbRefTypeAsString

java.lang.String getEjbRefTypeAsString()
Returns the ejb-ref-type element

Returns:
the node defined for the element ejb-ref-type

setLocalHome

EjbLocalRefType<T> setLocalHome(java.lang.String localHome)
If not already created, a new local-home element with the given value will be created. Otherwise, the existing local-home element will be updated with the given value.

Returns:
the current instance of EjbLocalRefType

removeLocalHome

EjbLocalRefType<T> removeLocalHome()
Removes the local-home element

Returns:
the current instance of EjbLocalRefType

getLocalHome

java.lang.String getLocalHome()
Returns the local-home element

Returns:
the node defined for the element local-home

setLocal

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

Returns:
the current instance of EjbLocalRefType

removeLocal

EjbLocalRefType<T> removeLocal()
Removes the local element

Returns:
the current instance of EjbLocalRefType

getLocal

java.lang.String getLocal()
Returns the local element

Returns:
the node defined for the element local

setEjbLink

EjbLocalRefType<T> setEjbLink(java.lang.String ejbLink)
If not already created, a new ejb-link element with the given value will be created. Otherwise, the existing ejb-link element will be updated with the given value.

Returns:
the current instance of EjbLocalRefType

removeEjbLink

EjbLocalRefType<T> removeEjbLink()
Removes the ejb-link element

Returns:
the current instance of EjbLocalRefType

getEjbLink

java.lang.String getEjbLink()
Returns the ejb-link element

Returns:
the node defined for the element ejb-link