org.eclipse.jst.j2ee.common
Interface ResourceRef

All Superinterfaces:
J2EEEObject

public interface ResourceRef
extends J2EEEObject

The resource-ref element contains a declaration of application clients's reference to an external resource. It consists of an optional description, the resource factory reference name, the indication of the resource factory type expected by the application client's code, and the type of authentication (bean or container). Example: EmployeeAppDB javax.sql.DataSource Container

Since:
1.0

Method Summary
 ResAuthTypeBase getAuth()
           
 java.lang.String getDescription()
           
 EList getDescriptions()
          Returns the value of the 'Descriptions' containment reference list.
 java.lang.String getLink()
           
 java.lang.String getName()
           
 ResSharingScopeType getResSharingScope()
           
 java.lang.String getType()
           
 boolean isSetAuth()
          Returns whether the value of the 'Auth' attribute is set
 boolean isSetResSharingScope()
          Returns whether the value of the 'Res Sharing Scope' attribute is set
 void setAuth(ResAuthTypeBase value)
          Sets the value of the 'Auth' attribute
 void setDescription(java.lang.String value)
           
 void setLink(java.lang.String value)
           
 void setName(java.lang.String value)
           
 void setResSharingScope(ResSharingScopeType value)
          Sets the value of the 'Res Sharing Scope' attribute
 void setType(java.lang.String value)
           
 void unsetAuth()
          Unsets the value of the 'Auth' attribute
 void unsetResSharingScope()
          Unsets the value of the 'Res Sharing Scope' attribute
 

Method Detail

getDescription

public java.lang.String getDescription()
Returns:
The value of the Description attribute The description element is used by the ejb-jar file producer to provide text describing the parent element. The description element 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 parent element.

setDescription

public void setDescription(java.lang.String value)
Parameters:
value - The new value of the Description attribute

getName

public java.lang.String getName()
Returns:
The value of the Name attribute The res-ref-name element specifies the name of the resource factory reference name. The resource factory reference name is the name of the application client's environment entry whose value contains the JNDI name of the data source.

setName

public void setName(java.lang.String value)
Parameters:
value - The new value of the Name attribute

getType

public java.lang.String getType()
Returns:
The value of the Type attribute The res-type element specifies the type of the data source. The type is specified by the Java interface (or class) expected to be implemented by the data source.

setType

public void setType(java.lang.String value)
Parameters:
value - The new value of the Type attribute

getAuth

public ResAuthTypeBase getAuth()
Returns:
The value of the Auth attribute The res-auth element specifies whether the enterprise bean code signs on programmatically to the resource manager, or whether the Container will sign on to the resource manager on behalf of the bean. In the latter case, the Container uses information that is supplied by the Deployer. The value of this element must be one of the two following: Application Container

setAuth

public void setAuth(ResAuthTypeBase value)
Sets the value of the 'Auth' attribute.

Parameters:
value - the new value of the 'Auth' attribute.
See Also:
ResAuthTypeBase, isSetAuth(), unsetAuth(), getAuth()

unsetAuth

public void unsetAuth()
Unsets the value of the 'Auth' attribute.

See Also:
isSetAuth(), getAuth(), setAuth(ResAuthTypeBase)

isSetAuth

public boolean isSetAuth()
Returns whether the value of the 'Auth' attribute is set.

Returns:
whether the value of the 'Auth' attribute is set.
See Also:
unsetAuth(), getAuth(), setAuth(ResAuthTypeBase)

getLink

public java.lang.String getLink()
Returns:
The value of the Link attribute

setLink

public void setLink(java.lang.String value)
Parameters:
value - The new value of the Link attribute

getResSharingScope

public ResSharingScopeType getResSharingScope()
Returns:
The value of the ResSharingScope attribute The res-sharing-scope element specifies whether connections obtained through the given resource manager connection factory reference can be shared. The value of this element, if specified, must be one of the two following: Shareable, Unshareable The default value is Shareable.

setResSharingScope

public void setResSharingScope(ResSharingScopeType value)
Sets the value of the 'Res Sharing Scope' attribute.

Parameters:
value - the new value of the 'Res Sharing Scope' attribute.
See Also:
ResSharingScopeType, isSetResSharingScope(), unsetResSharingScope(), getResSharingScope()

unsetResSharingScope

public void unsetResSharingScope()
Unsets the value of the 'Res Sharing Scope' attribute.

See Also:
isSetResSharingScope(), getResSharingScope(), setResSharingScope(ResSharingScopeType)

isSetResSharingScope

public boolean isSetResSharingScope()
Returns whether the value of the 'Res Sharing Scope' attribute is set.

Returns:
whether the value of the 'Res Sharing Scope' attribute is set.
See Also:
unsetResSharingScope(), getResSharingScope(), setResSharingScope(ResSharingScopeType)

getDescriptions

public 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.getResourceRef_Descriptions()