QueryResult (Apache DeltaSpike Sources 1.6.1 API)

Type Parameters:

E - Entity type
```
public interface QueryResult<E>
```
Can be used as query result type, which will not execute the query immediately. Allows some post processing like defining query ordering.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<X> QueryResult<E>`	`changeOrder(javax.persistence.metamodel.SingularAttribute<E,X> attribute)` Revert an existing order attribute sort direction.
`QueryResult<E>`	`changeOrder(String attribute)` Revert an existing order attribute sort direction.
`QueryResult<E>`	`clearOrder()` Remove any ordering from the query result object.
`long`	`count()` Count the result set.
`int`	`countPages()` Count the number of pages.
`int`	`currentPage()` Return the actual page.
`QueryResult<E>`	`firstResult(int first)` Pagination: Set the result start position.
`QueryResult<E>`	`flushMode(javax.persistence.FlushModeType flushMode)` Sets the query flush mode.
`E`	`getAnyResult()` Fetch a single result entity.
`E`	`getOptionalResult()` Fetch a single result entity.
`List<E>`	`getResultList()` Fetch the result set.
`E`	`getSingleResult()` Fetch a single result entity.
`QueryResult<E>`	`hint(String hint, Object value)` Apply a query hint to the query to execute.
`QueryResult<E>`	`lockMode(javax.persistence.LockModeType lockMode)` Sets the query lock mode.
`QueryResult<E>`	`maxResults(int max)` Limit the number of results returned by the query.
`QueryResult<E>`	`nextPage()` Move to the next page.
`<X> QueryResult<E>`	`orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)` Sort the query result ascending by the given entity singular attribute.
`<X> QueryResult<E>`	`orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute, boolean appendEntityName)` Sort the query result ascending by the given entity singular attribute.
`QueryResult<E>`	`orderAsc(String attribute)` Sort the query result ascending by the given entity attribute.
`QueryResult<E>`	`orderAsc(String attribute, boolean appendEntityName)` Sort the query result ascending by the given entity attribute.
`<X> QueryResult<E>`	`orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)` Sort the query result descending by the given entity singular attribute.
`<X> QueryResult<E>`	`orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute, boolean appendEntityName)` Sort the query result descending by the given entity singular attribute.
`QueryResult<E>`	`orderDesc(String attribute)` Sort the query result descending by the given entity attribute.
`QueryResult<E>`	`orderDesc(String attribute, boolean appendEntityName)` Sort the query result descending by the given entity attribute.
`int`	`pageSize()` Return the actual page size.
`QueryResult<E>`	`previousPage()` Move to the previous page.
`QueryResult<E>`	`toPage(int page)` Move the page cursor to a specific page.
`QueryResult<E>`	`withPageSize(int pageSize)` Set a page size on the query result.

- Method Detail
  - orderAsc
```
<X> QueryResult<E> orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)
```
    Sort the query result ascending by the given entity singular attribute. This is the typesafe version, alternatively a orderAsc(String) String can be used.
    
    Parameters:
    
    attribute - Sort attribute.
    
    Returns:
    
    Fluent API: the result instance.
  - orderAsc
```
<X> QueryResult<E> orderAsc(javax.persistence.metamodel.SingularAttribute<E,X> attribute,
                            boolean appendEntityName)
```
    Sort the query result ascending by the given entity singular attribute. This is the typesafe version, alternatively a orderAsc(String) String can be used.
    
    Parameters:
    
    attribute - Sort attribute.
    
    appendEntityName - whether the entity name 'e' should be appended to this attribute
    
    Returns:
    
    Fluent API: the result instance.
  - orderAsc
```
QueryResult<E> orderAsc(String attribute)
```
    Sort the query result ascending by the given entity attribute.
    
    Parameters:
    
    attribute - Sort attribute.
    
    Returns:
    
    Fluent API: the result instance.
  - orderAsc
```
QueryResult<E> orderAsc(String attribute,
                        boolean appendEntityName)
```
    Sort the query result ascending by the given entity attribute.
    
    Parameters:
    
    attribute - Sort attribute.
    
    appendEntityName - whether the entity name 'e' should be appended to this attribute
    
    Returns:
    
    Fluent API: the result instance.
  - orderDesc
```
<X> QueryResult<E> orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute)
```
    Sort the query result descending by the given entity singular attribute. This is the typesafe version, alternatively a orderDesc(String) String can be used.
    
    Parameters:
    
    attribute - Sort attribute.
    
    Returns:
    
    Fluent API: the result instance.
  - orderDesc
```
<X> QueryResult<E> orderDesc(javax.persistence.metamodel.SingularAttribute<E,X> attribute,
                             boolean appendEntityName)
```
    Sort the query result descending by the given entity singular attribute. This is the typesafe version, alternatively a orderDesc(String) String can be used.
    
    Parameters:
    
    attribute - Sort attribute.
    
    appendEntityName - whether the entity name 'e' should be appended to this attribute
    
    Returns:
    
    Fluent API: the result instance.
  - orderDesc
```
QueryResult<E> orderDesc(String attribute)
```
    Sort the query result descending by the given entity attribute.
    
    Parameters:
    
    attribute - Sort attribute.
    
    Returns:
    
    Fluent API: the result instance.
  - orderDesc
```
QueryResult<E> orderDesc(String attribute,
                         boolean appendEntityName)
```
    Sort the query result descending by the given entity attribute.
    
    Parameters:
    
    attribute - Sort attribute.
    
    appendEntityName - whether the entity name 'e' should be appended to this attribute
    
    Returns:
    
    Fluent API: the result instance.
  - changeOrder
```
<X> QueryResult<E> changeOrder(javax.persistence.metamodel.SingularAttribute<E,X> attribute)
```
    Revert an existing order attribute sort direction. Defaults to ascending order if the sort attribute was not used before.
    
    Parameters:
    
    attribute - Sort attribute.
    
    Returns:
    
    Fluent API: the result instance.
  - clearOrder
```
QueryResult<E> clearOrder()
```
    Remove any ordering from the query result object.
    
    Returns:
    
    Fluent API: the result instance.
  - changeOrder
```
QueryResult<E> changeOrder(String attribute)
```
    Revert an existing order attribute sort direction. Defaults to ascending order if the sort attribute was not used before.
    
    Parameters:
    
    attribute - Sort attribute.
    
    Returns:
    
    Fluent API: the result instance.
  - maxResults
```
QueryResult<E> maxResults(int max)
```
    Limit the number of results returned by the query.
    
    Parameters:
    
    max - Max number of results.
    
    Returns:
    
    Fluent API: the result instance.
  - firstResult
```
QueryResult<E> firstResult(int first)
```
    Pagination: Set the result start position.
    
    Parameters:
    
    first - Result start position.
    
    Returns:
    
    Fluent API: the result instance.
  - lockMode
```
QueryResult<E> lockMode(javax.persistence.LockModeType lockMode)
```
    Sets the query lock mode.
    
    Parameters:
    
    lockMode - Query lock mode to use in the query.
    
    Returns:
    
    Fluent API: the result instance.
  - flushMode
```
QueryResult<E> flushMode(javax.persistence.FlushModeType flushMode)
```
    Sets the query flush mode.
    
    Parameters:
    
    flushMode - Query flush mode to use in the query.
    
    Returns:
    
    Fluent API: the result instance.
  - hint
```
QueryResult<E> hint(String hint,
                    Object value)
```
    Apply a query hint to the query to execute.
    
    Parameters:
    
    hint - Hint name.
    
    value - Hint value.
    
    Returns:
    
    Fluent API: the result instance.
  - getResultList
```
List<E> getResultList()
```
    Fetch the result set.
    
    Returns:
    
    List of entities retrieved by the query.
  - getSingleResult
```
E getSingleResult()
```
    Fetch a single result entity.
    
    Returns:
    
    Entity retrieved by the query.
  - getOptionalResult
```
E getOptionalResult()
```
    Fetch a single result entity. Returns null if no result is found.
    
    Returns:
    
    Entity retrieved by the query, or null if no result.
  - getAnyResult
```
E getAnyResult()
```
    Fetch a single result entity. Returns null if no result is found. If the query finds multiple results, it simply returns the first one found.
    
    Returns:
    
    First Entity retrieved by the query, or null if no result.
  - count
```
long count()
```
    Count the result set.
    
    Returns:
    
    Result count.
  - withPageSize
```
QueryResult<E> withPageSize(int pageSize)
```
    Set a page size on the query result. Defaults to 10 or takes the value of a previous maxResults(int) call.
    
    Parameters:
    
    pageSize - Page size for further queries.
    
    Returns:
    
    Fluent API: the result instance.
  - toPage
```
QueryResult<E> toPage(int page)
```
    Move the page cursor to a specific page.
    
    Parameters:
    
    page - Page to move to for the next query.
    
    Returns:
    
    Fluent API: the result instance.
  - nextPage
```
QueryResult<E> nextPage()
```
    Move to the next page.
    
    Returns:
    
    Fluent API: the result instance.
  - previousPage
```
QueryResult<E> previousPage()
```
    Move to the previous page.
    
    Returns:
    
    Fluent API: the result instance.
  - countPages
```
int countPages()
```
    Count the number of pages.
    
    Returns:
    
    Page count.
  - currentPage
```
int currentPage()
```
    Return the actual page.
    
    Returns:
    
    Page position.
  - pageSize
```
int pageSize()
```
    Return the actual page size.
    
    Returns:
    
    Page size.

Interface QueryResult<E>

Method Summary

Method Detail

orderAsc

orderAsc

orderAsc

orderAsc

orderDesc

orderDesc

orderDesc

orderDesc

changeOrder

clearOrder

changeOrder

maxResults

firstResult

lockMode

flushMode

hint

getResultList

getSingleResult

getOptionalResult

getAnyResult

count

withPageSize

toPage

nextPage

previousPage

countPages

currentPage

pageSize