TypedQuery (CUBA 6.8 API)

All Superinterfaces:

Query

All Known Implementing Classes:

QueryImpl
```
public interface TypedQuery<T>
extends Query
```
Type-safe extension of Query interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TypedQuery<T>`	`addView(java.lang.Class<? extends Entity> entityClass, java.lang.String viewName)` Adds View for this Query instance.
`TypedQuery<T>`	`addView(View view)` Adds View for this Query instance.
`TypedQuery<T>`	`addViewName(java.lang.String viewName)` Adds View for this Query instance.
`T`	`getFirstResult()` Execute a SELECT query. Returns null if there is no result. Returns first result if more than one result.
`java.util.List<T>`	`getResultList()` Execute a SELECT query and return the query results as a List.
`T`	`getSingleResult()` Execute a SELECT query that returns a single result.
`TypedQuery<T>`	`setCacheable(boolean cacheable)` Set query results to be cached
`TypedQuery<T>`	`setFirstResult(int firstResult)` Set the position of the first result to retrieve.
`TypedQuery<T>`	`setFlushMode(javax.persistence.FlushModeType flushMode)` Set the flush mode type to be used for the query execution.
`TypedQuery<T>`	`setLockMode(javax.persistence.LockModeType lockMode)` Set the lock mode type to be used for the query execution.
`TypedQuery<T>`	`setMaxResults(int maxResults)` Set the maximum number of results to retrieve.
`TypedQuery<T>`	`setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType)` Bind an instance of java.util.Date to a positional parameter.
`TypedQuery<T>`	`setParameter(int position, java.lang.Object value)` Bind an argument to a positional parameter.
`TypedQuery<T>`	`setParameter(int position, java.lang.Object value, boolean implicitConversions)` Bind an argument to a positional parameter.
`TypedQuery<T>`	`setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType)` Bind an instance of java.util.Date to a named parameter.
`TypedQuery<T>`	`setParameter(java.lang.String name, java.lang.Object value)` Bind an argument to a named parameter. In the query text, named parameters are marked with colon (e.g.
`TypedQuery<T>`	`setParameter(java.lang.String name, java.lang.Object value, boolean implicitConversions)` Bind an argument to a named parameter. In the query text, named parameters are marked with colon (e.g.
`TypedQuery<T>`	`setView(java.lang.Class<? extends Entity> entityClass, java.lang.String viewName)` Set View for this Query instance.
`TypedQuery<T>`	`setView(View view)` Set View for this Query instance.
`TypedQuery<T>`	`setViewName(java.lang.String viewName)` Set View for this Query instance.

Methods inherited from interface com.haulmont.cuba.core.Query
executeUpdate, getDelegate, getQueryString, setQueryString

- Method Detail
  - getResultList
```
java.util.List<T> getResultList()
```
    Description copied from interface: Query
    
    Execute a SELECT query and return the query results as a List.
    
    Specified by:
    
    getResultList in interface Query
    
    Returns:
    
    a list of the results
  - getSingleResult
```
T getSingleResult()
```
    Description copied from interface: Query
    
    Execute a SELECT query that returns a single result.
    
    Specified by:
    
    getSingleResult in interface Query
    
    Returns:
    
    the result
  - getFirstResult
```
@Nullable
T getFirstResult()
```
    Description copied from interface: Query
    
    Execute a SELECT query.
    Returns null if there is no result.
    Returns first result if more than one result.
    
    Specified by:
    
    getFirstResult in interface Query
    
    Returns:
    
    the result
  - setMaxResults
```
TypedQuery<T> setMaxResults(int maxResults)
```
    Description copied from interface: Query
    
    Set the maximum number of results to retrieve.
    
    Specified by:
    
    setMaxResults in interface Query
    
    Returns:
    
    the same query instance
  - setFirstResult
```
TypedQuery<T> setFirstResult(int firstResult)
```
    Description copied from interface: Query
    
    Set the position of the first result to retrieve.
    
    Specified by:
    
    setFirstResult in interface Query
    
    Parameters:
    
    firstResult - position of the first result, numbered from 0
    
    Returns:
    
    the same query instance
  - setParameter
```
TypedQuery<T> setParameter(java.lang.String name,
                           java.lang.Object value)
```
    Description copied from interface: Query
    
    Bind an argument to a named parameter.
    
    In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    name - parameter name
    
    value - parameter value. Entity instance replaced with its ID.
    
    Returns:
    
    the same query instance
  - setParameter
```
TypedQuery<T> setParameter(java.lang.String name,
                           java.lang.Object value,
                           boolean implicitConversions)
```
    Description copied from interface: Query
    
    Bind an argument to a named parameter.
    
    In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    name - parameter name
    
    value - parameter value
    
    implicitConversions - whether to make parameter value conversions, e.g. convert an entity to its ID
    
    Returns:
    
    the same query instance
  - setParameter
```
TypedQuery<T> setParameter(java.lang.String name,
                           java.util.Date value,
                           javax.persistence.TemporalType temporalType)
```
    Description copied from interface: Query
    
    Bind an instance of java.util.Date to a named parameter.
    
    In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    name - parameter name
    
    value - parameter value
    
    temporalType - type of Date value
    
    Returns:
    
    the same query instance
  - setParameter
```
TypedQuery<T> setParameter(int position,
                           java.lang.Object value)
```
    Description copied from interface: Query
    
    Bind an argument to a positional parameter.
    In the query text, positional parameters are marked with ?N (e.g. ?1).
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    position - parameter position, starting with 1
    
    value - parameter value. Entity instance replaced with its ID.
    
    Returns:
    
    the same query instance
  - setParameter
```
TypedQuery<T> setParameter(int position,
                           java.lang.Object value,
                           boolean implicitConversions)
```
    Description copied from interface: Query
    
    Bind an argument to a positional parameter.
    In the query text, positional parameters are marked with ?N (e.g. ?1).
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    position - parameter position, starting with 1
    
    value - parameter value
    
    implicitConversions - whether to make parameter value conversions, e.g. convert an entity to its ID
    
    Returns:
    
    the same query instance
  - setParameter
```
TypedQuery<T> setParameter(int position,
                           java.util.Date value,
                           javax.persistence.TemporalType temporalType)
```
    Description copied from interface: Query
    
    Bind an instance of java.util.Date to a positional parameter.
    In the query text, positional parameters are marked with ?N (e.g. ?1).
    
    Specified by:
    
    setParameter in interface Query
    
    Parameters:
    
    position - parameter position, starting with 1
    
    value - parameter value
    
    temporalType - type of Date value
    
    Returns:
    
    the same query instance
  - setLockMode
```
TypedQuery<T> setLockMode(javax.persistence.LockModeType lockMode)
```
    Description copied from interface: Query
    
    Set the lock mode type to be used for the query execution.
    
    Specified by:
    
    setLockMode in interface Query
    
    Parameters:
    
    lockMode - lock mode
    
    Returns:
    
    the same query instance
  - setView
```
TypedQuery<T> setView(@Nullable
                      View view)
```
    Description copied from interface: Query
    
    Set View for this Query instance.
    All non-lazy view properties contained in a combination of all added views are eagerly fetched.
    
    Specified by:
    
    setView in interface Query
    
    Parameters:
    
    view - view instance. If null, eager fetching is performed according to JPA mappings.
    
    Returns:
    
    the same query instance
  - setView
```
TypedQuery<T> setView(java.lang.Class<? extends Entity> entityClass,
                      java.lang.String viewName)
```
    Description copied from interface: Query
    
    Set View for this Query instance.
    All non-lazy view properties contained in a combination of all added views are eagerly fetched.
    
    Specified by:
    
    setView in interface Query
    
    Parameters:
    
    entityClass - entity class to get a view instance by the name provided
    
    viewName - view name
    
    Returns:
    
    the same query instance
  - addView
```
TypedQuery<T> addView(View view)
```
    Description copied from interface: Query
    
    Adds View for this Query instance.
    All non-lazy view properties contained in a combination of all added views are eagerly fetched.
    
    Specified by:
    
    addView in interface Query
    
    Parameters:
    
    view - view instance - must not be null
    
    Returns:
    
    the same query instance
  - addView
```
TypedQuery<T> addView(java.lang.Class<? extends Entity> entityClass,
                      java.lang.String viewName)
```
    Description copied from interface: Query
    
    Adds View for this Query instance.
    All non-lazy view properties contained in a combination of all added views are eagerly fetched.
    
    Specified by:
    
    addView in interface Query
    
    Parameters:
    
    entityClass - entity class to get a view instance by the name provided
    
    viewName - view name - must not be null
    
    Returns:
    
    the same query instance
  - setViewName
```
TypedQuery<T> setViewName(java.lang.String viewName)
```
    Set View for this Query instance.
    All non-lazy view properties contained in a combination of all added views are eagerly fetched.
    
    Parameters:
    
    viewName - view name - must not be null
    
    Returns:
    
    the same query instance
  - addViewName
```
TypedQuery<T> addViewName(java.lang.String viewName)
```
    Adds View for this Query instance.
    All non-lazy view properties contained in a combination of all added views are eagerly fetched.
    
    Parameters:
    
    viewName - view name - must not be null
    
    Returns:
    
    the same query instance
  - setCacheable
```
TypedQuery<T> setCacheable(boolean cacheable)
```
    Set query results to be cached
    
    Specified by:
    
    setCacheable in interface Query
    
    Parameters:
    
    cacheable - whether query is cacheable
    
    Returns:
    
    the same query instance
  - setFlushMode
```
TypedQuery<T> setFlushMode(javax.persistence.FlushModeType flushMode)
```
    Set the flush mode type to be used for the query execution.
    
    Specified by:
    
    setFlushMode in interface Query
    
    Parameters:
    
    flushMode - flush mode
    
    Returns:
    
    the same query instance

Interface TypedQuery<T>

Method Summary

Methods inherited from interface com.haulmont.cuba.core.Query

Method Detail

getResultList

getSingleResult

getFirstResult

setMaxResults

setFirstResult

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setLockMode

setView

setView

addView

addView

setViewName

addViewName

setCacheable

setFlushMode