ResourceEnvRef

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

public class ResourceEnvRef
extends java.lang.Object

The resource-env-refType is used to define resource-env-type elements. It contains a declaration of a Deployment Component's reference to an administered object associated with a resource in the Deployment Component's environment. It consists of an optional description, the resource environment reference name, and an indication of the resource environment reference type expected by the Deployment Component code.

Example:

 <?xml version="1.0" encoding="UTF-8"?><resource-env-ref xmlns:com.ibm.etools.j2ee.common="common.xmi" xmlns:com.ibm.etools.webservice.wsclient="webservice_client.xmi" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" xmlns:org.eclipse.jem.java="java.xmi" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><resource-env-ref-name>

                                                jms/StockQueue

                                        </resource-env-ref-name><resource-env-ref-type>

                                                javax.jms.Queue

                                        </resource-env-ref-type>

                                </resource-env-ref>

Java class for ResourceEnvRef complex type.

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

 <complexType name="ResourceEnvRef">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="type" type="{java.xmi}JavaClass"/>
         </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="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute ref="{http://www.omg.org/XMI}id"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`description`
`protected java.util.List<Description>`	`descriptions`
`protected java.util.List<Extension>`	`extensions`
`protected java.lang.String`	`href`
`protected java.lang.String`	`id`
`protected java.lang.Object`	`idref`
`protected java.lang.String`	`label`
`protected java.lang.String`	`name`
`protected java.util.List<JavaClass>`	`resourceEnvRefTypes`
`protected java.lang.String`	`resourceEnvRefTypeString`
`protected javax.xml.namespace.QName`	`type`
`protected java.lang.String`	`uuid`
`protected java.lang.String`	`version`

Constructor Summary

Constructors
Constructor and Description

ResourceEnvRef()

Constructors
Constructor and Description
`ResourceEnvRef()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()` Gets the value of the description property.
`java.util.List<Description>`	`getDescriptions()` Gets the value of the descriptions property.
`java.util.List<Extension>`	`getExtensions()` Gets the value of the extensions property.
`java.lang.String`	`getHref()` Gets the value of the href property.
`java.lang.String`	`getId()` Gets the value of the id property.
`java.lang.Object`	`getIdref()` Gets the value of the idref property.
`java.lang.String`	`getLabel()` Gets the value of the label property.
`java.lang.String`	`getName()` Gets the value of the name property.
`java.util.List<JavaClass>`	`getResourceEnvRefTypes()` Gets the value of the resourceEnvRefTypes property.
`java.lang.String`	`getResourceEnvRefTypeString()` Gets the value of the resourceEnvRefTypeString property.
`javax.xml.namespace.QName`	`getType()` Gets the value of the type property.
`java.lang.String`	`getUuid()` Gets the value of the uuid property.
`java.lang.String`	`getVersion()` Gets the value of the version property.
`void`	`setDescription(java.lang.String value)` Sets the value of the description property.
`void`	`setHref(java.lang.String value)` Sets the value of the href property.
`void`	`setId(java.lang.String value)` Sets the value of the id property.
`void`	`setIdref(java.lang.Object value)` Sets the value of the idref property.
`void`	`setLabel(java.lang.String value)` Sets the value of the label property.
`void`	`setName(java.lang.String value)` Sets the value of the name property.
`void`	`setResourceEnvRefTypeString(java.lang.String value)` Sets the value of the resourceEnvRefTypeString property.
`void`	`setType(javax.xml.namespace.QName value)` Sets the value of the type property.
`void`	`setUuid(java.lang.String value)` Sets the value of the uuid property.
`void`	`setVersion(java.lang.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
  - resourceEnvRefTypes
```
protected java.util.List<JavaClass> resourceEnvRefTypes
```
  - descriptions
```
protected java.util.List<Description> descriptions
```
  - extensions
```
protected java.util.List<Extension> extensions
```
  - description
```
protected java.lang.String description
```
  - name
```
protected java.lang.String name
```
  - resourceEnvRefTypeString
```
protected java.lang.String resourceEnvRefTypeString
```
  - id
```
protected java.lang.String id
```
  - type
```
protected javax.xml.namespace.QName type
```
  - version
```
protected java.lang.String version
```
  - href
```
protected java.lang.String href
```
  - idref
```
protected java.lang.Object idref
```
  - label
```
protected java.lang.String label
```
  - uuid
```
protected java.lang.String uuid
```
- Constructor Detail
  - ResourceEnvRef
```
public ResourceEnvRef()
```
- Method Detail
  - getResourceEnvRefTypes
```
public java.util.List<JavaClass> getResourceEnvRefTypes()
```
    Gets the value of the resourceEnvRefTypes 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 resourceEnvRefTypes property.
    
    For example, to add a new item, do as follows:
```
 getResourceEnvRefTypes().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list JavaClass
  - getDescriptions
```
public java.util.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 java.util.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 java.lang.String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getName
```
public java.lang.String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(java.lang.String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getResourceEnvRefTypeString
```
public java.lang.String getResourceEnvRefTypeString()
```
    Gets the value of the resourceEnvRefTypeString property.
    
    Returns:
    
    possible object is String
  - setResourceEnvRefTypeString
```
public void setResourceEnvRefTypeString(java.lang.String value)
```
    Sets the value of the resourceEnvRefTypeString property.
    
    Parameters:
    
    value - allowed object is String
  - getId
```
public java.lang.String getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(java.lang.String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public javax.xml.namespace.QName getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is QName
  - setType
```
public void setType(javax.xml.namespace.QName value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is QName
  - getVersion
```
public java.lang.String getVersion()
```
    Gets the value of the version property.
    
    Returns:
    
    possible object is String
  - setVersion
```
public void setVersion(java.lang.String value)
```
    Sets the value of the version property.
    
    Parameters:
    
    value - allowed object is String
  - getHref
```
public java.lang.String getHref()
```
    Gets the value of the href property.
    
    Returns:
    
    possible object is String
  - setHref
```
public void setHref(java.lang.String value)
```
    Sets the value of the href property.
    
    Parameters:
    
    value - allowed object is String
  - getIdref
```
public java.lang.Object getIdref()
```
    Gets the value of the idref property.
    
    Returns:
    
    possible object is Object
  - setIdref
```
public void setIdref(java.lang.Object value)
```
    Sets the value of the idref property.
    
    Parameters:
    
    value - allowed object is Object
  - getLabel
```
public java.lang.String getLabel()
```
    Gets the value of the label property.
    
    Returns:
    
    possible object is String
  - setLabel
```
public void setLabel(java.lang.String value)
```
    Sets the value of the label property.
    
    Parameters:
    
    value - allowed object is String
  - getUuid
```
public java.lang.String getUuid()
```
    Gets the value of the uuid property.
    
    Returns:
    
    possible object is String
  - setUuid
```
public void setUuid(java.lang.String value)
```
    Sets the value of the uuid property.
    
    Parameters:
    
    value - allowed object is String

Class ResourceEnvRef

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

resourceEnvRefTypes

descriptions

extensions

description

name

resourceEnvRefTypeString

id

type

version

href

idref

label

uuid

Constructor Detail

ResourceEnvRef

Method Detail

getResourceEnvRefTypes

getDescriptions

getExtensions

getDescription

setDescription

getName

setName

getResourceEnvRefTypeString

setResourceEnvRefTypeString

getId

setId

getType

setType

getVersion

setVersion

getHref

setHref

getIdref

setIdref

getLabel

setLabel

getUuid

setUuid