org.eclipse.modisco.jee.webapp.webapp30
Interface EnvEntryType


public interface EnvEntryType

A representation of the model object 'Env Entry Type'. The env-entryType is used to declare an application's environment entry. The declaration consists of an optional description, the name of the environment entry, a type (optional if the value is injected, otherwise required), and an optional value. It also includes optional elements to define injection of the named resource into fields or JavaBeans properties. If a value is not specified and injection is requested, no injection will occur and no entry of the specified name will be created. This allows an initial value to be specified in the source code without being incorrectly changed when no override has been specified. If a value is not specified and no injection is requested, a value must be supplied during deployment. This type is used by env-entry elements.

The following features are supported:

See Also:
Webapp30Package.getEnvEntryType()
Generated:
Model:
extendedMetaData="name='env-entryType' kind='elementOnly'"

Method Summary
  getDescription()
          Returns the value of the 'Description' containment reference list.
 JndiNameType getEnvEntryName()
          Returns the value of the 'Env Entry Name' containment reference.
 EnvEntryTypeValuesType getEnvEntryType()
          Returns the value of the 'Env Entry Type' containment reference.
 XsdStringType getEnvEntryValue()
          Returns the value of the 'Env Entry Value' containment reference.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
  getInjectionTarget()
          Returns the value of the 'Injection Target' containment reference list.
 XsdStringType getLookupName()
          Returns the value of the 'Lookup Name' containment reference.
 XsdStringType getMappedName()
          Returns the value of the 'Mapped Name' containment reference.
 void setEnvEntryName(JndiNameType value)
          Sets the value of the 'Env Entry Name' containment reference.
 void setEnvEntryType(EnvEntryTypeValuesType value)
          Sets the value of the 'Env Entry Type' containment reference.
 void setEnvEntryValue(XsdStringType value)
          Sets the value of the 'Env Entry Value' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setLookupName(XsdStringType value)
          Sets the value of the 'Lookup Name' containment reference.
 void setMappedName(XsdStringType value)
          Sets the value of the 'Mapped Name' containment reference.
 

Method Detail

getDescription

 getDescription()
Returns the value of the 'Description' containment reference list. The list contents are of type DescriptionType.

If the meaning of the 'Description' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference list.
See Also:
Webapp30Package.getEnvEntryType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getEnvEntryName

JndiNameType getEnvEntryName()
Returns the value of the 'Env Entry Name' containment reference. minAmount ]]>

Returns:
the value of the 'Env Entry Name' containment reference.
See Also:
setEnvEntryName(JndiNameType), Webapp30Package.getEnvEntryType_EnvEntryName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='env-entry-name' namespace='http://java.sun.com/xml/ns/javaee'"

setEnvEntryName

void setEnvEntryName(JndiNameType value)
Sets the value of the 'Env Entry Name' containment reference.

Parameters:
value - the new value of the 'Env Entry Name' containment reference.
See Also:
getEnvEntryName()
Generated:

getEnvEntryType

EnvEntryTypeValuesType getEnvEntryType()
Returns the value of the 'Env Entry Type' containment reference. java.lang.Integer ]]>

Returns:
the value of the 'Env Entry Type' containment reference.
See Also:
setEnvEntryType(EnvEntryTypeValuesType), Webapp30Package.getEnvEntryType_EnvEntryType()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='env-entry-type' namespace='http://java.sun.com/xml/ns/javaee'"

setEnvEntryType

void setEnvEntryType(EnvEntryTypeValuesType value)
Sets the value of the 'Env Entry Type' containment reference.

Parameters:
value - the new value of the 'Env Entry Type' containment reference.
See Also:
getEnvEntryType()
Generated:

getEnvEntryValue

XsdStringType getEnvEntryValue()
Returns the value of the 'Env Entry Value' containment reference. 100.00 ]]>

Returns:
the value of the 'Env Entry Value' containment reference.
See Also:
setEnvEntryValue(XsdStringType), Webapp30Package.getEnvEntryType_EnvEntryValue()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='env-entry-value' namespace='http://java.sun.com/xml/ns/javaee'"

setEnvEntryValue

void setEnvEntryValue(XsdStringType value)
Sets the value of the 'Env Entry Value' containment reference.

Parameters:
value - the new value of the 'Env Entry Value' containment reference.
See Also:
getEnvEntryValue()
Generated:

getMappedName

XsdStringType getMappedName()
Returns the value of the 'Mapped Name' containment reference. A product specific name that this resource should be mapped to. The name of this resource, as defined by the resource's name element or defaulted, is a name that is local to the application component using the resource. (It's a name in the JNDI java:comp/env namespace.) Many application servers provide a way to map these local names to names of resources known to the application server. This mapped name is often a global JNDI name, but may be a name of any form. Application servers are not required to support any particular form or type of mapped name, nor the ability to use mapped names. The mapped name is product-dependent and often installation-dependent. No use of a mapped name is portable.

Returns:
the value of the 'Mapped Name' containment reference.
See Also:
setMappedName(XsdStringType), Webapp30Package.getEnvEntryType_MappedName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='mapped-name' namespace='http://java.sun.com/xml/ns/javaee'"

setMappedName

void setMappedName(XsdStringType value)
Sets the value of the 'Mapped Name' containment reference.

Parameters:
value - the new value of the 'Mapped Name' containment reference.
See Also:
getMappedName()
Generated:

getInjectionTarget

 getInjectionTarget()
Returns the value of the 'Injection Target' containment reference list. The list contents are of type InjectionTargetType.

If the meaning of the 'Injection Target' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Injection Target' containment reference list.
See Also:
Webapp30Package.getEnvEntryType_InjectionTarget()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='injection-target' namespace='http://java.sun.com/xml/ns/javaee'"

getLookupName

XsdStringType getLookupName()
Returns the value of the 'Lookup Name' containment reference. The JNDI name to be looked up to resolve a resource reference.

Returns:
the value of the 'Lookup Name' containment reference.
See Also:
setLookupName(XsdStringType), Webapp30Package.getEnvEntryType_LookupName()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='lookup-name' namespace='http://java.sun.com/xml/ns/javaee'"

setLookupName

void setLookupName(XsdStringType value)
Sets the value of the 'Lookup Name' containment reference.

Parameters:
value - the new value of the 'Lookup Name' containment reference.
See Also:
getLookupName()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), Webapp30Package.getEnvEntryType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: