org.eclipse.jst.j2ee.ejb
Interface Query

All Superinterfaces:
org.eclipse.emf.ecore.EObject, J2EEEObject, org.eclipse.emf.common.notify.Notifier

public interface Query
extends J2EEEObject

The query element is used to specify a finder or select query. It contains an optional description of the query; the specification of the finder or select method it is used by; a specification of the return type mapping, if any, if the query is for a select method; and the EJB QL query string that defines the query. Queries that are expressible in EJB QL must use the ejb-ql element to specify the query. If a query is not expressible in EJB QL, the description element should be used to describe the semantics of the query and the ejb-ql element should be empty.

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 getEjbQL()
           
 ContainerManagedEntity getEntity()
           
 QueryMethod getQueryMethod()
           
 ReturnTypeMapping getReturnTypeMapping()
           
 boolean isLocalResultMapping()
          Returns boolean value for ReturnTypeMapping, checks if it is of type ReturnTypeMapping.LOCAL
 boolean isRemoteResultMapping()
          Returns boolean value for ReturnTypeMapping, checks if it is of type ReturnTypeMapping.REMOTE
 boolean isSetReturnTypeMapping()
          Returns whether the value of the 'Return Type Mapping' attribute is set
 void setDescription(java.lang.String value)
           
 void setEjbQL(java.lang.String value)
           
 void setEntity(ContainerManagedEntity value)
          Sets the value of the 'Entity' container reference
 void setQueryMethod(QueryMethod value)
           
 void setReturnTypeMapping(ReturnTypeMapping value)
          Sets the value of the 'Return Type Mapping' attribute
 void unsetReturnTypeMapping()
          Unsets the value of the 'Return Type Mapping' 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
 

Method Detail

isLocalResultMapping

boolean isLocalResultMapping()
Returns boolean value for ReturnTypeMapping, checks if it is of type ReturnTypeMapping.LOCAL

Returns:
boolean value

isRemoteResultMapping

boolean isRemoteResultMapping()
Returns boolean value for ReturnTypeMapping, checks if it is of type ReturnTypeMapping.REMOTE

Returns:
boolean value

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 query. 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

getEjbQL

java.lang.String getEjbQL()
Returns:
The value of the EjbQL attribute Contains the EJB QL query string that defines a finder or select query. This element is defined within the scope of a query element whose contents specify the finder or the select method that uses the query. The content must be a valid EJB QL query string for the entity bean for which the query is specified. The ejb-ql element must be specified for all queries that are expressible in EJB QL.

setEjbQL

void setEjbQL(java.lang.String value)
Parameters:
value - The new value of the EjbQL attribute

getReturnTypeMapping

ReturnTypeMapping getReturnTypeMapping()
Returns:
The value of the ReturnTypeMapping attribute The return-type-mapping element is used in the query element to specify whether an abstract schema type that is returned by a query for a select method is to be mapped to an EJBLocalObject or EJBObject type. The value of the return-type-mapping element, if specified must be one of the following.

setReturnTypeMapping

void setReturnTypeMapping(ReturnTypeMapping value)
Sets the value of the 'Return Type Mapping' attribute.

Parameters:
value - the new value of the 'Return Type Mapping' attribute.
See Also:
ReturnTypeMapping, isSetReturnTypeMapping(), unsetReturnTypeMapping(), getReturnTypeMapping()

unsetReturnTypeMapping

void unsetReturnTypeMapping()
Unsets the value of the 'Return Type Mapping' attribute.

See Also:
isSetReturnTypeMapping(), getReturnTypeMapping(), setReturnTypeMapping(ReturnTypeMapping)

isSetReturnTypeMapping

boolean isSetReturnTypeMapping()
Returns whether the value of the 'Return Type Mapping' attribute is set.

Returns:
whether the value of the 'Return Type Mapping' attribute is set.
See Also:
unsetReturnTypeMapping(), getReturnTypeMapping(), setReturnTypeMapping(ReturnTypeMapping)

getQueryMethod

QueryMethod getQueryMethod()
Returns:
The QueryMethod reference The query-method element is used to specify the method (DB//SR//CM-"on the home") for a finder or select query. The method-name element specifies the name of a finder or select method in the entity bean's implementation class or a select method in the dependent object class. Each method-param must be defined for a query-method using the method-params element. Used in: query Example: Example: Method finds large orders findLargeOrders SELECT ENTITY(o) FROM Order o WHERE o.amount > 1000

setQueryMethod

void setQueryMethod(QueryMethod value)
Parameters:
value - The new value of the QueryMethod reference

getEntity

ContainerManagedEntity getEntity()
Returns:
The Entity reference

setEntity

void setEntity(ContainerManagedEntity value)
Sets the value of the 'Entity' container reference.

Parameters:
value - the new value of the 'Entity' container reference.
See Also:
getEntity()

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:
EjbPackage.getQuery_Descriptions()