EjbRef (OpenEJB :: Container :: Java EE 4.7.5 API)

java.lang.Object
- org.apache.openejb.jee.was.v6.common.EjbRef

Direct Known Subclasses:: EJBLocalRef

public class EjbRef
extends Object

The ejb-refType is used by ejb-ref elements for the declaration of a reference to an enterprise bean's home. 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 expected type of the referenced enterprise bean - the expected home and remote interfaces of the referenced enterprise bean - optional ejb-link information, used to specify the referenced enterprise bean

Java class for EjbRef complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="EjbRef">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="descriptions" type="{common.xmi}Description"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element ref="{http://www.omg.org/XMI}Extension"/>
         </choice>
       </choice>
       <attGroup ref="{http://www.omg.org/XMI}ObjectAttribs"/>
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="home" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="link" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="remote" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" type="{common.xmi}EjbRefType" />
       <attribute ref="{http://www.omg.org/XMI}id"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description`
`protected List<Description>`	`descriptions`
`protected EjbRefEnum`	`ejbRefType`
`protected List<Extension>`	`extensions`
`protected String`	`home`
`protected String`	`href`
`protected String`	`id`
`protected Object`	`idref`
`protected String`	`label`
`protected String`	`link`
`protected String`	`name`
`protected String`	`remote`
`protected QName`	`type`
`protected String`	`uuid`
`protected String`	`version`

Constructor Summary

Constructors
Constructor and Description

EjbRef()

Constructors
Constructor and Description
`EjbRef()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Gets the value of the description property.
`List<Description>`	`getDescriptions()` Gets the value of the descriptions property.
`EjbRefEnum`	`getEjbRefType()` Gets the value of the ejbRefType property.
`List<Extension>`	`getExtensions()` Gets the value of the extensions property.
`String`	`getHome()` Gets the value of the home 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.
`String`	`getLink()` Gets the value of the link property.
`String`	`getName()` Gets the value of the name property.
`String`	`getRemote()` Gets the value of the remote 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.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setEjbRefType(EjbRefEnum value)` Sets the value of the ejbRefType property.
`void`	`setHome(String value)` Sets the value of the home 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`	`setLink(String value)` Sets the value of the link property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setRemote(String value)` Sets the value of the remote 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
  - descriptions
```
protected List<Description> descriptions
```
  - extensions
```
protected List<Extension> extensions
```
  - description
```
protected String description
```
  - home
```
protected String home
```
  - link
```
protected String link
```
  - name
```
protected String name
```
  - remote
```
protected String remote
```
  - ejbRefType
```
protected EjbRefEnum ejbRefType
```
  - 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
  - EjbRef
```
public EjbRef()
```
- Method Detail
  - 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
  - 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
  - getHome
```
public String getHome()
```
    Gets the value of the home property.
    
    Returns:
    possible object is String
  - setHome
```
public void setHome(String value)
```
    Sets the value of the home property.
    
    Parameters:
    value - allowed object is String
  - getLink
```
public String getLink()
```
    Gets the value of the link property.
    
    Returns:
    possible object is String
  - setLink
```
public void setLink(String value)
```
    Sets the value of the link property.
    
    Parameters:
    value - allowed object is String
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    value - allowed object is String
  - getRemote
```
public String getRemote()
```
    Gets the value of the remote property.
    
    Returns:
    possible object is String
  - setRemote
```
public void setRemote(String value)
```
    Sets the value of the remote property.
    
    Parameters:
    value - allowed object is String
  - getEjbRefType
```
public EjbRefEnum getEjbRefType()
```
    Gets the value of the ejbRefType property.
    
    Returns:
    possible object is EjbRefEnum
  - setEjbRefType
```
public void setEjbRefType(EjbRefEnum value)
```
    Sets the value of the ejbRefType property.
    
    Parameters:
    value - allowed object is EjbRefEnum
  - 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 EjbRef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

descriptions

extensions

description

home

link

name

remote

ejbRefType

id

type

version

href

idref

label

uuid

Constructor Detail

EjbRef

Method Detail

getDescriptions

getExtensions

getDescription

setDescription

getHome

setHome

getLink

setLink

getName

setName

getRemote

setRemote

getEjbRefType

setEjbRefType

getId

setId

getType

setType

getVersion

setVersion

getHref

setHref

getIdref

setIdref

getLabel

setLabel

getUuid

setUuid