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


public interface ResourceRefType

A representation of the model object 'Resource Ref Type'. jdbc/EmployeeAppDB javax.sql.DataSource Container Shareable ]]>

The following features are supported:

See Also:
Webapp30Package.getResourceRefType()
Generated:
Model:
extendedMetaData="name='resource-refType' kind='elementOnly'"

Method Summary
  getDescription()
          Returns the value of the 'Description' containment reference list.
 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.
 ResAuthType getResAuth()
          Returns the value of the 'Res Auth' containment reference.
 JndiNameType getResRefName()
          Returns the value of the 'Res Ref Name' containment reference.
 ResSharingScopeType getResSharingScope()
          Returns the value of the 'Res Sharing Scope' containment reference.
 FullyQualifiedClassType getResType()
          Returns the value of the 'Res Type' 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.
 void setResAuth(ResAuthType value)
          Sets the value of the 'Res Auth' containment reference.
 void setResRefName(JndiNameType value)
          Sets the value of the 'Res Ref Name' containment reference.
 void setResSharingScope(ResSharingScopeType value)
          Sets the value of the 'Res Sharing Scope' containment reference.
 void setResType(FullyQualifiedClassType value)
          Sets the value of the 'Res Type' 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.getResourceRefType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/javaee'"

getResRefName

JndiNameType getResRefName()
Returns the value of the 'Res Ref Name' containment reference. The res-ref-name element specifies the name of a resource manager connection factory reference. The name is a JNDI name relative to the java:comp/env context. The name must be unique within a Deployment File.

Returns:
the value of the 'Res Ref Name' containment reference.
See Also:
setResRefName(JndiNameType), Webapp30Package.getResourceRefType_ResRefName()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='res-ref-name' namespace='http://java.sun.com/xml/ns/javaee'"

setResRefName

void setResRefName(JndiNameType value)
Sets the value of the 'Res Ref Name' containment reference.

Parameters:
value - the new value of the 'Res Ref Name' containment reference.
See Also:
getResRefName()
Generated:

getResType

FullyQualifiedClassType getResType()
Returns the value of the 'Res Type' containment reference. The res-type element specifies the type of the data source. The type is specified by the fully qualified Java language class or interface expected to be implemented by the data source.

Returns:
the value of the 'Res Type' containment reference.
See Also:
setResType(FullyQualifiedClassType), Webapp30Package.getResourceRefType_ResType()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='res-type' namespace='http://java.sun.com/xml/ns/javaee'"

setResType

void setResType(FullyQualifiedClassType value)
Sets the value of the 'Res Type' containment reference.

Parameters:
value - the new value of the 'Res Type' containment reference.
See Also:
getResType()
Generated:

getResAuth

ResAuthType getResAuth()
Returns the value of the 'Res Auth' containment reference.

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

Returns:
the value of the 'Res Auth' containment reference.
See Also:
setResAuth(ResAuthType), Webapp30Package.getResourceRefType_ResAuth()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='res-auth' namespace='http://java.sun.com/xml/ns/javaee'"

setResAuth

void setResAuth(ResAuthType value)
Sets the value of the 'Res Auth' containment reference.

Parameters:
value - the new value of the 'Res Auth' containment reference.
See Also:
getResAuth()
Generated:

getResSharingScope

ResSharingScopeType getResSharingScope()
Returns the value of the 'Res Sharing Scope' containment reference.

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

Returns:
the value of the 'Res Sharing Scope' containment reference.
See Also:
setResSharingScope(ResSharingScopeType), Webapp30Package.getResourceRefType_ResSharingScope()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='res-sharing-scope' namespace='http://java.sun.com/xml/ns/javaee'"

setResSharingScope

void setResSharingScope(ResSharingScopeType value)
Sets the value of the 'Res Sharing Scope' containment reference.

Parameters:
value - the new value of the 'Res Sharing Scope' containment reference.
See Also:
getResSharingScope()
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.getResourceRefType_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.getResourceRefType_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.getResourceRefType_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.getResourceRefType_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: