Query
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 queryis 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.
Attributes Summary
description The description is used by the ejb-jar file producer to provide text describing the query. ejbQL Contains the EJB QL query string that defines a finder or select query. returnTypeMapping 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. queryMethod The query-method element is used to specify the method (DB/SR/CM-"on the home") for a finder orselect query. entity
Attribute Details
description
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.
Data type: String
Default value: unspecified
ejbQL
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.@invariant The value must be a valid EJB QL query string for the entity bean or dependent object class for which the query is specified.@invariant The ejb-ql element must be specified for all queries that are expressible in EJB QL.Example:<query><query-method><method-name>ejbSelectPendingLineitems</method-name><method-params/></query-method><ejb-ql>SELECT ENTITY(l)FROM LineItems lWHERE l.shipped is FALSE</ejb-ql></query>
Data type: String
Default value: unspecified
returnTypeMapping
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.
Data type: ReturnTypeMapping
Default value: unspecified
Allowed Values: Remote Local
queryMethod
The query-method element is used to specify the method (DB/SR/CM-"on the home") for a finder orselect query.The method-name element specifies the name of a finder or selectmethod in the entity bean's implementation class or a select method inthe dependent object class.Each method-param must be defined for a query-method using themethod-params element.Used in: queryExample:Example:<query> <description>Method finds large orders</description> <query-method> <method-name>findLargeOrders</method-name> <method-params></method-params> </query-method> <ejb-ql>SELECT ENTITY(o) FROM Order o WHERE o.amount > 1000</ejb-ql></query>
Data type: QueryMethod
entity
Data type: