|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface QueryType<T>
This interface defines the contract for the queryType xsd type
Original Documentation:
The queryType defines 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
- an optional specification of the result type
mapping, if the query is for a select method
and entity objects are returned.
- 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.
The result-type-mapping is an optional element. It can only
be present if the query-method specifies a select method
that returns entity objects. The default value for the
result-type-mapping element is "Local".
| Method Summary | |
|---|---|
java.lang.String |
getDescription()
Returns the description element |
java.lang.String |
getEjbQl()
Returns the ejb-ql element |
ResultTypeMappingType |
getResultTypeMapping()
Returns the result-type-mapping element |
java.lang.String |
getResultTypeMappingAsString()
Returns the result-type-mapping element |
QueryMethodType<QueryType<T>> |
queryMethod()
If not already created, a new query-method element will be created and returned. |
QueryType<T> |
removeDescription()
Removes the description element |
QueryType<T> |
removeEjbQl()
Removes the ejb-ql element |
QueryType<T> |
removeQueryMethod()
Removes the query-method element |
QueryType<T> |
setDescription(java.lang.String description)
If not already created, a new description element with the given value will be created. |
QueryType<T> |
setEjbQl(java.lang.String ejbQl)
If not already created, a new ejb-ql element with the given value will be created. |
QueryType<T> |
setResultTypeMapping(ResultTypeMappingType resultTypeMapping)
If not already created, a new result-type-mapping element with the given value will be created. |
QueryType<T> |
setResultTypeMapping(java.lang.String resultTypeMapping)
If not already created, a new result-type-mapping element with the given value will be created. |
| Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child |
|---|
up |
| Method Detail |
|---|
QueryType<T> setDescription(java.lang.String description)
description element with the given value will be created.
Otherwise, the existing description element will be updated with the given value.
QueryTypeQueryType<T> removeDescription()
description element
QueryTypejava.lang.String getDescription()
description element
descriptionQueryType<T> removeQueryMethod()
query-method element
QueryTypeQueryMethodType<QueryType<T>> queryMethod()
query-method element will be created and returned.
Otherwise, the existing query-method element will be returned.
query-methodQueryType<T> setResultTypeMapping(ResultTypeMappingType resultTypeMapping)
result-type-mapping element with the given value will be created.
Otherwise, the existing result-type-mapping element will be updated with the given value.
QueryTypeQueryType<T> setResultTypeMapping(java.lang.String resultTypeMapping)
result-type-mapping element with the given value will be created.
Otherwise, the existing result-type-mapping element will be updated with the given value.
QueryTypeResultTypeMappingType getResultTypeMapping()
result-type-mapping element
result-type-mappingjava.lang.String getResultTypeMappingAsString()
result-type-mapping element
result-type-mappingQueryType<T> setEjbQl(java.lang.String ejbQl)
ejb-ql element with the given value will be created.
Otherwise, the existing ejb-ql element will be updated with the given value.
QueryTypeQueryType<T> removeEjbQl()
ejb-ql element
QueryTypejava.lang.String getEjbQl()
ejb-ql element
ejb-ql
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||