Interface ExtendedQueryResult<E>
- Type Parameters:
E- Entity type.
- All Superinterfaces:
org.apache.deltaspike.data.api.QueryResult<E>
public interface ExtendedQueryResult<E>
extends org.apache.deltaspike.data.api.QueryResult<E>
An extended version of
QueryResult that allows to configure Blaze-Persistence specific features.- Since:
- 1.2.0
- Author:
- Christian Beikov
-
Method Summary
Modifier and Type Method Description ExtendedQueryResult<E>changeOrder(String attribute)<X> ExtendedQueryResult<E>changeOrder(javax.persistence.metamodel.SingularAttribute<E,X> attribute)ExtendedQueryResult<E>clearOrder()ExtendedQueryResult<E>firstResult(int first)ExtendedQueryResult<E>flushMode(javax.persistence.FlushModeType flushMode)List<E>getPageResultList()Returns the result list of the page for which this query was constructed for without executing a count query.List<E>getResultList()If paginated, returns aPagedListcontaining the result list of the requested page and optionally the total count depending onwithCountQuery(boolean).ExtendedQueryResult<E>hint(String hint, Object value)ExtendedQueryResult<E>lockMode(javax.persistence.LockModeType lockMode)ExtendedQueryResult<E>maxResults(int max)ExtendedQueryResult<E>nextPage()ExtendedQueryResult<E>orderAsc(String attribute)ExtendedQueryResult<E>orderAsc(String attribute, boolean appendEntityName)<X> ExtendedQueryResult<E>orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)<X> ExtendedQueryResult<E>orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute, boolean appendEntityName)ExtendedQueryResult<E>orderDesc(String attribute)ExtendedQueryResult<E>orderDesc(String attribute, boolean appendEntityName)<X> ExtendedQueryResult<E>orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)<X> ExtendedQueryResult<E>orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute, boolean appendEntityName)ExtendedQueryResult<E>previousPage()ExtendedQueryResult<E>toPage(int page)ExtendedQueryResult<E>withCountQuery(boolean withCountQuery)Enables or disables the execution of the count query which determines whetherPagedList.getTotalSize()is available.ExtendedQueryResult<E>withPageSize(int pageSize)
-
Method Details
-
getPageResultList
Returns the result list of the page for which this query was constructed for without executing a count query.- Returns:
- The result list of the requested page
-
getResultList
If paginated, returns aPagedListcontaining the result list of the requested page and optionally the total count depending onwithCountQuery(boolean). Otherwise, returns aList. -
withCountQuery
Enables or disables the execution of the count query which determines whetherPagedList.getTotalSize()is available.- Parameters:
withCountQuery- true to enable, false to disable the count query execution- Returns:
- The query result for chaining calls
-
orderAsc
- Specified by:
orderAscin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderAsc
<X> ExtendedQueryResult<E> orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute, boolean appendEntityName)- Specified by:
orderAscin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderAsc
- Specified by:
orderAscin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderAsc
- Specified by:
orderAscin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderDesc
<X> ExtendedQueryResult<E> orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)- Specified by:
orderDescin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderDesc
<X> ExtendedQueryResult<E> orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute, boolean appendEntityName)- Specified by:
orderDescin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderDesc
- Specified by:
orderDescin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
orderDesc
- Specified by:
orderDescin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
changeOrder
<X> ExtendedQueryResult<E> changeOrder(javax.persistence.metamodel.SingularAttribute<E,X> attribute)- Specified by:
changeOrderin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
clearOrder
ExtendedQueryResult<E> clearOrder()- Specified by:
clearOrderin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
changeOrder
- Specified by:
changeOrderin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
maxResults
- Specified by:
maxResultsin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
firstResult
- Specified by:
firstResultin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
lockMode
- Specified by:
lockModein interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
flushMode
- Specified by:
flushModein interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
hint
- Specified by:
hintin interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
withPageSize
- Specified by:
withPageSizein interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
toPage
- Specified by:
toPagein interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
nextPage
ExtendedQueryResult<E> nextPage()- Specified by:
nextPagein interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-
previousPage
ExtendedQueryResult<E> previousPage()- Specified by:
previousPagein interfaceorg.apache.deltaspike.data.api.QueryResult<E>
-