org.eclipse.jst.j2ee.common
Interface ResourceEnvRef
- All Superinterfaces:
- org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier
public interface ResourceEnvRef
- extends J2EEEObject
The resource-env-ref element contains a declaration of an enterprise bean's reference to an administered object associated with a resource in the enterprise bean'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 enterprise bean code.
Examples:
jms//StockQueue/resource-env-ref-name>
javax.jms.Queue/resource-env-ref-type>
/resource-env-ref>
- Since:
- 1.0
Method Summary |
java.lang.String |
getDescription()
|
org.eclipse.emf.common.util.EList |
getDescriptions()
Returns the value of the 'Descriptions' containment reference list. |
java.lang.String |
getName()
|
JavaClass |
getType()
|
java.lang.String |
getTypeName()
Gets the name for the type |
void |
setDescription(java.lang.String value)
|
void |
setName(java.lang.String value)
|
void |
setType(JavaClass value)
|
void |
setTypeName(java.lang.String className)
Sets the name of the type attribute |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
eAdapters, eDeliver, eNotify, eSetDeliver |
getTypeName
java.lang.String getTypeName()
- Gets the name for the type
- Returns:
- String value
setTypeName
void setTypeName(java.lang.String className)
- Sets the name of the type attribute
- Parameters:
className
- sets the name for the type
getDescription
java.lang.String getDescription()
- Returns:
- The value of the Description attribute
The description is used by the ejb-jar file producer to provide text describing
the resource env ref.
The description should include any information that the ejb-jar file producer
wants to provide to the consumer of the ejb-jar file (i.e. to the Deployer).
Typically, the tools used by the ejb-jar file consumer will display the
description when processing the list of dependents.
setDescription
void setDescription(java.lang.String value)
- Parameters:
value
- The new value of the Description attribute
getName
java.lang.String getName()
- Returns:
- The value of the Name attribute
Specifies the name of a resource environment reference; its value is the
environment entry name used in the enterprise bean code.
setName
void setName(java.lang.String value)
- Parameters:
value
- The new value of the Name attribute
getType
JavaClass getType()
- Returns:
- The Type reference
Specifies the type of a resource environment reference. See the class
description for an example.
setType
void setType(JavaClass value)
- Parameters:
value
- The new value of the Type reference
getDescriptions
org.eclipse.emf.common.util.EList getDescriptions()
- Returns the value of the 'Descriptions' containment reference list.
The list contents are of type
Description
.
If the meaning of the 'Descriptions' containment reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Descriptions' containment reference list.
- See Also:
CommonPackage.getResourceEnvRef_Descriptions()