ExtendedQueryResult (Blazebit Persistence Integration DeltaSpike Data API 1.4.0-Alpha2 API)

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ExtendedQueryResult<E>`	`changeOrder(java.lang.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)`
`java.util.List<E>`	`getPageResultList()`	Returns the result list of the page for which this query was constructed for without executing a count query.
`java.util.List<E>`	`getResultList()`	If paginated, returns a `PagedList` containing the result list of the requested page and optionally the total count depending on `withCountQuery(boolean)`.
`ExtendedQueryResult<E>`	`hint(java.lang.String hint, java.lang.Object value)`
`ExtendedQueryResult<E>`	`lockMode(javax.persistence.LockModeType lockMode)`
`ExtendedQueryResult<E>`	`maxResults(int max)`
`ExtendedQueryResult<E>`	`nextPage()`
`ExtendedQueryResult<E>`	`orderAsc(java.lang.String attribute)`
`ExtendedQueryResult<E>`	`orderAsc(java.lang.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(java.lang.String attribute)`
`ExtendedQueryResult<E>`	`orderDesc(java.lang.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 whether `PagedList.getTotalSize()` is available.
`ExtendedQueryResult<E>`	`withPageSize(int pageSize)`

Methods inherited from interface org.apache.deltaspike.data.api.QueryResult
count, countPages, currentPage, getAnyResult, getOptionalResult, getSingleResult, pageSize

- Method Detail
  - getPageResultList
```
java.util.List<E> 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
```
java.util.List<E> getResultList()
```
    If paginated, returns a PagedList containing the result list of the requested page and optionally the total count depending on withCountQuery(boolean). Otherwise, returns a List.
    
    Specified by:
    
    getResultList in interface org.apache.deltaspike.data.api.QueryResult<E>
    
    Returns:
    
    The result as PagedList if paginated or List otherwise
  - withCountQuery
```
ExtendedQueryResult<E> withCountQuery(boolean withCountQuery)
```
    Enables or disables the execution of the count query which determines whether PagedList.getTotalSize() is available.
    
    Parameters:
    
    withCountQuery - true to enable, false to disable the count query execution
    
    Returns:
    
    The query result for chaining calls
  - orderAsc
```
<X> ExtendedQueryResult<E> orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)
```
    Specified by:
    
    orderAsc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderAsc
```
<X> ExtendedQueryResult<E> orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute,
                                    boolean appendEntityName)
```
    Specified by:
    
    orderAsc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderAsc
```
ExtendedQueryResult<E> orderAsc(java.lang.String attribute)
```
    Specified by:
    
    orderAsc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderAsc
```
ExtendedQueryResult<E> orderAsc(java.lang.String attribute,
                                boolean appendEntityName)
```
    Specified by:
    
    orderAsc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderDesc
```
<X> ExtendedQueryResult<E> orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)
```
    Specified by:
    
    orderDesc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderDesc
```
<X> ExtendedQueryResult<E> orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute,
                                     boolean appendEntityName)
```
    Specified by:
    
    orderDesc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderDesc
```
ExtendedQueryResult<E> orderDesc(java.lang.String attribute)
```
    Specified by:
    
    orderDesc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - orderDesc
```
ExtendedQueryResult<E> orderDesc(java.lang.String attribute,
                                 boolean appendEntityName)
```
    Specified by:
    
    orderDesc in interface org.apache.deltaspike.data.api.QueryResult<E>
  - changeOrder
```
<X> ExtendedQueryResult<E> changeOrder(javax.persistence.metamodel.SingularAttribute<E,X> attribute)
```
    Specified by:
    
    changeOrder in interface org.apache.deltaspike.data.api.QueryResult<E>
  - clearOrder
```
ExtendedQueryResult<E> clearOrder()
```
    Specified by:
    
    clearOrder in interface org.apache.deltaspike.data.api.QueryResult<E>
  - changeOrder
```
ExtendedQueryResult<E> changeOrder(java.lang.String attribute)
```
    Specified by:
    
    changeOrder in interface org.apache.deltaspike.data.api.QueryResult<E>
  - maxResults
```
ExtendedQueryResult<E> maxResults(int max)
```
    Specified by:
    
    maxResults in interface org.apache.deltaspike.data.api.QueryResult<E>
  - firstResult
```
ExtendedQueryResult<E> firstResult(int first)
```
    Specified by:
    
    firstResult in interface org.apache.deltaspike.data.api.QueryResult<E>
  - lockMode
```
ExtendedQueryResult<E> lockMode(javax.persistence.LockModeType lockMode)
```
    Specified by:
    
    lockMode in interface org.apache.deltaspike.data.api.QueryResult<E>
  - flushMode
```
ExtendedQueryResult<E> flushMode(javax.persistence.FlushModeType flushMode)
```
    Specified by:
    
    flushMode in interface org.apache.deltaspike.data.api.QueryResult<E>
  - hint
```
ExtendedQueryResult<E> hint(java.lang.String hint,
                            java.lang.Object value)
```
    Specified by:
    
    hint in interface org.apache.deltaspike.data.api.QueryResult<E>
  - withPageSize
```
ExtendedQueryResult<E> withPageSize(int pageSize)
```
    Specified by:
    
    withPageSize in interface org.apache.deltaspike.data.api.QueryResult<E>
  - toPage
```
ExtendedQueryResult<E> toPage(int page)
```
    Specified by:
    
    toPage in interface org.apache.deltaspike.data.api.QueryResult<E>
  - nextPage
```
ExtendedQueryResult<E> nextPage()
```
    Specified by:
    
    nextPage in interface org.apache.deltaspike.data.api.QueryResult<E>
  - previousPage
```
ExtendedQueryResult<E> previousPage()
```
    Specified by:
    
    previousPage in interface org.apache.deltaspike.data.api.QueryResult<E>

Interface ExtendedQueryResult<E>

Method Summary

Methods inherited from interface org.apache.deltaspike.data.api.QueryResult

Method Detail

getPageResultList

getResultList

withCountQuery

orderAsc

orderAsc

orderAsc

orderAsc

orderDesc

orderDesc

orderDesc

orderDesc

changeOrder

clearOrder

changeOrder

maxResults

firstResult

lockMode

flushMode

hint

withPageSize

toPage

nextPage

previousPage