Query (Red Hat JBoss Enterprise Application Platform 7.0.0.GA public API)

All Superinterfaces:

BasicQueryContract

All Known Subinterfaces:

FullTextQuery, SQLQuery

All Known Implementing Classes:

AbstractQueryImpl, CollectionFilterImpl, FullTextQueryImpl, QueryImpl, SQLQueryImpl
```
public interface Query
extends BasicQueryContract
```
An object-oriented representation of a Hibernate query. A Query instance is obtained by calling Session.createQuery(). This interface exposes some extra functionality beyond that provided by Session.iterate() and Session.find():
- a particular page of the result set may be selected by calling setMaxResults(), setFirstResult()
- named query parameters may be used
- the results may be returned as an instance of ScrollableResults
Named query parameters are tokens of the form :name in the query string. A value is bound to the integer parameter :foo by calling

setParameter("foo", foo, Hibernate.INTEGER);

for example. A name may appear multiple times in the query string.

JDBC-style ? parameters are also supported. To bind a value to a JDBC-style parameter use a set method that accepts an int positional argument (numbered from zero, contrary to JDBC).

You may not mix and match JDBC-style parameters and named parameters in the same query.

Queries are executed by calling list(), scroll() or iterate(). A query may be re-executed by subsequent invocations. Its lifespan is, however, bounded by the lifespan of the Session that created it.

Implementors are not intended to be threadsafe.
Author:

Gavin King

See Also:

SharedSessionContract.createQuery(java.lang.String), ScrollableResults

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Query`	`addQueryHint(String hint)` Add a DB query hint to the SQL.
`int`	`executeUpdate()` Execute the update or delete statement.
`String`	`getComment()` Obtain the comment currently associated with this query.
`Integer`	`getFirstResult()` Obtain the value specified (if any) for the first row to be returned from the query results; zero-based.
`LockOptions`	`getLockOptions()` Obtains the LockOptions in effect for this query.
`Integer`	`getMaxResults()` Obtains the limit set on the maximum number of rows to retrieve.
`String[]`	`getNamedParameters()` Return the names of all named parameters of the query.
`String`	`getQueryString()` Get the query string.
`String[]`	`getReturnAliases()` Return the HQL select clause aliases, if any.
`Iterator`	`iterate()` Return the query results as an `Iterator`.
`List`	`list()` Return the query results as a `List`.
`ScrollableResults`	`scroll()` Return the query results as `ScrollableResults`.
`ScrollableResults`	`scroll(ScrollMode scrollMode)` Return the query results as ScrollableResults.
`Query`	`setBigDecimal(int position, BigDecimal number)` Bind a positional BigDecimal-valued parameter.
`Query`	`setBigDecimal(String name, BigDecimal number)` Bind a named BigDecimal-valued parameter.
`Query`	`setBigInteger(int position, BigInteger number)` Bind a positional BigDecimal-valued parameter.
`Query`	`setBigInteger(String name, BigInteger number)` Bind a named BigInteger-valued parameter.
`Query`	`setBinary(int position, byte[] val)` Bind a positional binary-valued parameter.
`Query`	`setBinary(String name, byte[] val)` Bind a named binary-valued parameter.
`Query`	`setBoolean(int position, boolean val)` Bind a positional boolean-valued parameter.
`Query`	`setBoolean(String name, boolean val)` Bind a named boolean-valued parameter.
`Query`	`setByte(int position, byte val)` Bind a positional byte-valued parameter.
`Query`	`setByte(String name, byte val)` Bind a named byte-valued parameter.
`Query`	`setCacheable(boolean cacheable)` Enable/disable second level query (result) caching for this query.
`Query`	`setCacheMode(CacheMode cacheMode)` (Re)set the current CacheMode in effect for this query.
`Query`	`setCacheRegion(String cacheRegion)` Set the name of the cache region where query results should be cached (if cached at all).
`Query`	`setCalendar(int position, Calendar calendar)` Bind a positional Calendar-valued parameter using the full Timestamp portion.
`Query`	`setCalendar(String name, Calendar calendar)` Bind a named Calendar-valued parameter using the full Timestamp.
`Query`	`setCalendarDate(int position, Calendar calendar)` Bind a positional Calendar-valued parameter using just the Date portion.
`Query`	`setCalendarDate(String name, Calendar calendar)` Bind a named Calendar-valued parameter using just the Date portion.
`Query`	`setCharacter(int position, char val)` Bind a positional char-valued parameter.
`Query`	`setCharacter(String name, char val)` Bind a named char-valued parameter.
`Query`	`setComment(String comment)` Set the comment for this query.
`Query`	`setDate(int position, Date date)` Bind a positional Date-valued parameter using just the Date portion.
`Query`	`setDate(String name, Date date)` Bind the date (time is truncated) of a given Date object to a named query parameter.
`Query`	`setDouble(int position, double val)` Bind a positional double-valued parameter.
`Query`	`setDouble(String name, double val)` Bind a named double-valued parameter.
`Query`	`setEntity(int position, Object val)` Bind an instance of a mapped persistent class to a JDBC-style query parameter.
`Query`	`setEntity(String name, Object val)` Bind an instance of a mapped persistent class to a named query parameter.
`Query`	`setFetchSize(int fetchSize)` Sets a JDBC fetch size hint for the query.
`Query`	`setFirstResult(int firstResult)` Set the first row to retrieve.
`Query`	`setFloat(int position, float val)` Bind a positional float-valued parameter.
`Query`	`setFloat(String name, float val)` Bind a named float-valued parameter.
`Query`	`setFlushMode(FlushMode flushMode)` (Re)set the current FlushMode in effect for this query.
`Query`	`setInteger(int position, int val)` Bind a positional int-valued parameter.
`Query`	`setInteger(String name, int val)` Bind a named int-valued parameter.
`Query`	`setLocale(int position, Locale locale)` Bind a positional Locale-valued parameter.
`Query`	`setLocale(String name, Locale locale)` Bind a named Locale-valued parameter.
`Query`	`setLockMode(String alias, LockMode lockMode)` Set the LockMode to use for specific alias (as defined in the query's `FROM` clause).
`Query`	`setLockOptions(LockOptions lockOptions)` Set the lock options for the query.
`Query`	`setLong(int position, long val)` Bind a positional long-valued parameter.
`Query`	`setLong(String name, long val)` Bind a named long-valued parameter.
`Query`	`setMaxResults(int maxResults)` Set the maximum number of rows to retrieve.
`Query`	`setParameter(int position, Object val)` Bind a value to a JDBC-style query parameter.
`Query`	`setParameter(int position, Object val, Type type)` Bind a value to a JDBC-style query parameter.
`Query`	`setParameter(String name, Object val)` Bind a value to a named query parameter.
`Query`	`setParameter(String name, Object val, Type type)` Bind a value to a named query parameter.
`Query`	`setParameterList(String name, Collection values)` Bind multiple values to a named query parameter.
`Query`	`setParameterList(String name, Collection values, Type type)` Bind multiple values to a named query parameter.
`Query`	`setParameterList(String name, Object[] values)` Bind multiple values to a named query parameter.
`Query`	`setParameterList(String name, Object[] values, Type type)` Bind multiple values to a named query parameter.
`Query`	`setParameters(Object[] values, Type[] types)` Bind values and types to positional parameters.
`Query`	`setProperties(Map bean)` Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
`Query`	`setProperties(Object bean)` Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
`Query`	`setReadOnly(boolean readOnly)` Set the read-only/modifiable mode for entities and proxies loaded by this Query.
`Query`	`setResultTransformer(ResultTransformer transformer)` Set a strategy for handling the query results.
`Query`	`setSerializable(int position, Serializable val)` Bind a positional binary-valued parameter using serialization.
`Query`	`setSerializable(String name, Serializable val)` Bind a named binary-valued parameter using serialization.
`Query`	`setShort(int position, short val)` Bind a positional short-valued parameter.
`Query`	`setShort(String name, short val)` Bind a named short-valued parameter.
`Query`	`setString(int position, String val)` Bind a positional String-valued parameter.
`Query`	`setString(String name, String val)` Bind a named String-valued parameter.
`Query`	`setText(int position, String val)` Bind a positional String-valued parameter using streaming.
`Query`	`setText(String name, String val)` Bind a named String-valued parameter using streaming.
`Query`	`setTime(int position, Date date)` Bind a positional Date-valued parameter using just the Time portion.
`Query`	`setTime(String name, Date date)` Bind the time (date is truncated) of a given Date object to a named query parameter.
`Query`	`setTimeout(int timeout)` Set the query timeout in seconds.
`Query`	`setTimestamp(int position, Date date)` Bind a positional Date-valued parameter using the full Timestamp.
`Query`	`setTimestamp(String name, Date date)` Bind the date and the time of a given Date object to a named query parameter.
`Object`	`uniqueResult()` Convenience method to return a single instance that matches the query, or null if the query returns no results.

Methods inherited from interface org.hibernate.BasicQueryContract
getCacheMode, getCacheRegion, getFetchSize, getFlushMode, getReturnTypes, getTimeout, isCacheable, isReadOnly

- Method Detail
  - getQueryString
```
String getQueryString()
```
    Get the query string.
    
    Returns:
    
    the query string
  - getMaxResults
```
Integer getMaxResults()
```
    Obtains the limit set on the maximum number of rows to retrieve. No set limit means there is no limit set on the number of rows returned. Technically both null and any negative values are interpreted as no limit; however, this method should always return null in such case.
    
    Returns:
    
    The
  - setMaxResults
```
Query setMaxResults(int maxResults)
```
    Set the maximum number of rows to retrieve.
    
    Parameters:
    
    maxResults - the maximum number of rows
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    getMaxResults()
  - getFirstResult
```
Integer getFirstResult()
```
    Obtain the value specified (if any) for the first row to be returned from the query results; zero-based. Used, in conjunction with getMaxResults() in "paginated queries". No value specified means the first result is returned. Zero and negative numbers are the same as no setting.
    
    Returns:
    
    The first result number.
  - setFirstResult
```
Query setFirstResult(int firstResult)
```
    Set the first row to retrieve.
    
    Parameters:
    
    firstResult - a row number, numbered from 0
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    getFirstResult()
  - setFlushMode
```
Query setFlushMode(FlushMode flushMode)
```
    Description copied from interface: BasicQueryContract
    
    (Re)set the current FlushMode in effect for this query.
    
    Specified by:
    
    setFlushMode in interface BasicQueryContract
    
    Parameters:
    
    flushMode - The new FlushMode to use.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getFlushMode()
  - setCacheMode
```
Query setCacheMode(CacheMode cacheMode)
```
    Description copied from interface: BasicQueryContract
    
    (Re)set the current CacheMode in effect for this query.
    
    Specified by:
    
    setCacheMode in interface BasicQueryContract
    
    Parameters:
    
    cacheMode - The new CacheMode to use.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getCacheMode()
  - setCacheable
```
Query setCacheable(boolean cacheable)
```
    Description copied from interface: BasicQueryContract
    
    Enable/disable second level query (result) caching for this query.
    
    Specified by:
    
    setCacheable in interface BasicQueryContract
    
    Parameters:
    
    cacheable - Should the query results be cacheable?
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.isCacheable()
  - setCacheRegion
```
Query setCacheRegion(String cacheRegion)
```
    Description copied from interface: BasicQueryContract
    
    Set the name of the cache region where query results should be cached (if cached at all).
    
    Specified by:
    
    setCacheRegion in interface BasicQueryContract
    
    Parameters:
    
    cacheRegion - the name of a query cache region, or null to indicate that the default region should be used.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getCacheRegion()
  - setTimeout
```
Query setTimeout(int timeout)
```
    Description copied from interface: BasicQueryContract
    
    Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.
    
    Specified by:
    
    setTimeout in interface BasicQueryContract
    
    Parameters:
    
    timeout - the timeout in seconds
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getTimeout()
  - setFetchSize
```
Query setFetchSize(int fetchSize)
```
    Description copied from interface: BasicQueryContract
    
    Sets a JDBC fetch size hint for the query.
    
    Specified by:
    
    setFetchSize in interface BasicQueryContract
    
    Parameters:
    
    fetchSize - the fetch size hint
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    BasicQueryContract.getFetchSize()
  - setReadOnly
```
Query setReadOnly(boolean readOnly)
```
    Description copied from interface: BasicQueryContract
    
    Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
    
    Specified by:
    
    setReadOnly in interface BasicQueryContract
    
    Parameters:
    
    readOnly - true, entities and proxies loaded by the query will be put in read-only mode false, entities and proxies loaded by the query will be put in modifiable mode
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session:, PersistenceContext.setDefaultReadOnly(boolean), Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted. When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting. The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.
  - getLockOptions
```
LockOptions getLockOptions()
```
    Obtains the LockOptions in effect for this query.
    
    Returns:
    
    The LockOptions
    
    See Also:
    
    LockOptions
  - setLockOptions
```
Query setLockOptions(LockOptions lockOptions)
```
    Set the lock options for the query. Specifically only the following are taken into consideration:
    For alias-specific locking, use setLockMode(String, LockMode).
    Parameters:
    
    lockOptions - The lock options to apply to the query.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    getLockOptions()
  - setLockMode
```
Query setLockMode(String alias,
                  LockMode lockMode)
```
    Set the LockMode to use for specific alias (as defined in the query's FROM clause). The alias-specific lock modes specified here are added to the query's internal LockOptions. The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally speaking, for maximum portability, this method should only be used to mark that the rows corresponding to the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE).
    
    Parameters:
    
    alias - a query alias, or "this" for a collection filter
    
    lockMode - The lock mode to apply.
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    getLockOptions()
  - getComment
```
String getComment()
```
    Obtain the comment currently associated with this query. Provided SQL commenting is enabled (generally by enabling the hibernate.use_sql_comments config setting), this comment will also be added to the SQL query sent to the database. Often useful for identifying the source of troublesome queries on the database side.
    
    Returns:
    
    The comment.
  - setComment
```
Query setComment(String comment)
```
    Set the comment for this query.
    
    Parameters:
    
    comment - The human-readable comment
    
    Returns:
    
    this, for method chaining
    
    See Also:
    
    getComment()
  - addQueryHint
```
Query addQueryHint(String hint)
```
    Add a DB query hint to the SQL. These differ from JPA's QueryHint, which is specific to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will determine concatenation and placement.
    
    Parameters:
    
    hint - The database specific query hint to add.
  - getReturnAliases
```
String[] getReturnAliases()
```
    Return the HQL select clause aliases, if any.
    
    Returns:
    
    an array of aliases as strings
  - getNamedParameters
```
String[] getNamedParameters()
```
    Return the names of all named parameters of the query.
    
    Returns:
    
    the parameter names, in no particular order
  - iterate
```
Iterator iterate()
```
    Return the query results as an Iterator. If the query contains multiple results pre row, the results are returned in an instance of Object[].
    
    Entities returned as results are initialized on demand. The first SQL query returns identifiers only.
    
    Returns:
    
    the result iterator
  - scroll
```
ScrollableResults scroll()
```
    Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.
    
    Returns:
    
    the result iterator
    
    See Also:
    
    ScrollableResults
  - scroll
```
ScrollableResults scroll(ScrollMode scrollMode)
```
    Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.
    
    Parameters:
    
    scrollMode - The scroll mode
    
    Returns:
    
    the result iterator
    
    See Also:
    
    ScrollableResults, ScrollMode
  - list
```
List list()
```
    Return the query results as a List. If the query contains multiple results per row, the results are returned in an instance of Object[].
    
    Returns:
    
    the result list
  - uniqueResult
```
Object uniqueResult()
```
    Convenience method to return a single instance that matches the query, or null if the query returns no results.
    
    Returns:
    
    the single result or null
    
    Throws:
    
    NonUniqueResultException - if there is more than one matching result
  - executeUpdate
```
int executeUpdate()
```
    Execute the update or delete statement. The semantics are compliant with the ejb3 Query.executeUpdate() method.
    
    Returns:
    
    The number of entities updated or deleted.
  - setParameter
```
Query setParameter(int position,
                   Object val,
                   Type type)
```
    Bind a value to a JDBC-style query parameter.
    
    Parameters:
    
    position - the position of the parameter in the query string, numbered from 0.
    
    val - the possibly-null parameter value
    
    type - the Hibernate type
    
    Returns:
    
    this, for method chaining
  - setParameter
```
Query setParameter(String name,
                   Object val,
                   Type type)
```
    Bind a value to a named query parameter.
    
    Parameters:
    
    name - the name of the parameter
    
    val - the possibly-null parameter value
    
    type - the Hibernate type
    
    Returns:
    
    this, for method chaining
  - setParameter
```
Query setParameter(int position,
                   Object val)
```
    Bind a value to a JDBC-style query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the given object.
    
    Parameters:
    
    position - the position of the parameter in the query string, numbered from 0.
    
    val - the non-null parameter value
    
    Returns:
    
    this, for method chaining
  - setParameter
```
Query setParameter(String name,
                   Object val)
```
    Bind a value to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the given object.
    
    Parameters:
    
    name - the name of the parameter
    
    val - the non-null parameter value
    
    Returns:
    
    this, for method chaining
  - setParameters
```
Query setParameters(Object[] values,
                    Type[] types)
```
    Bind values and types to positional parameters. Allows binding more than one at a time; no real performance impact. The number of elements in each array should match. That is, element number-0 in types array corresponds to element-0 in the values array, etc,
    
    Parameters:
    
    types - The types
    
    values - The values
    
    Returns:
    
    this, for method chaining
  - setParameterList
```
Query setParameterList(String name,
                       Collection values,
                       Type type)
```
    Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Parameters:
    
    name - the name of the parameter
    
    values - a collection of values to list
    
    type - the Hibernate type of the values
    
    Returns:
    
    this, for method chaining
  - setParameterList
```
Query setParameterList(String name,
                       Collection values)
```
    Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Parameters:
    
    name - the name of the parameter
    
    values - a collection of values to list
    
    Returns:
    
    this, for method chaining
  - setParameterList
```
Query setParameterList(String name,
                       Object[] values,
                       Type type)
```
    Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Parameters:
    
    name - the name of the parameter
    
    values - a collection of values to list
    
    type - the Hibernate type of the values
    
    Returns:
    
    this, for method chaining
  - setParameterList
```
Query setParameterList(String name,
                       Object[] values)
```
    Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
    
    Parameters:
    
    name - the name of the parameter
    
    values - a collection of values to list
    
    Returns:
    
    this, for method chaining
  - setProperties
```
Query setProperties(Object bean)
```
    Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
    
    Parameters:
    
    bean - any JavaBean or POJO
    
    Returns:
    
    this, for method chaining
  - setProperties
```
Query setProperties(Map bean)
```
    Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
    
    Parameters:
    
    bean - a java.util.Map
    
    Returns:
    
    this, for method chaining
  - setString
```
Query setString(int position,
                String val)
```
    Bind a positional String-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setCharacter
```
Query setCharacter(int position,
                   char val)
```
    Bind a positional char-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBoolean
```
Query setBoolean(int position,
                 boolean val)
```
    Bind a positional boolean-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setByte
```
Query setByte(int position,
              byte val)
```
    Bind a positional byte-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setShort
```
Query setShort(int position,
               short val)
```
    Bind a positional short-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setInteger
```
Query setInteger(int position,
                 int val)
```
    Bind a positional int-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setLong
```
Query setLong(int position,
              long val)
```
    Bind a positional long-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setFloat
```
Query setFloat(int position,
               float val)
```
    Bind a positional float-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setDouble
```
Query setDouble(int position,
                double val)
```
    Bind a positional double-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBinary
```
Query setBinary(int position,
                byte[] val)
```
    Bind a positional binary-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setText
```
Query setText(int position,
              String val)
```
    Bind a positional String-valued parameter using streaming.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setSerializable
```
Query setSerializable(int position,
                      Serializable val)
```
    Bind a positional binary-valued parameter using serialization.
    
    Parameters:
    
    position - The parameter position
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setLocale
```
Query setLocale(int position,
                Locale locale)
```
    Bind a positional Locale-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    locale - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigDecimal
```
Query setBigDecimal(int position,
                    BigDecimal number)
```
    Bind a positional BigDecimal-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigInteger
```
Query setBigInteger(int position,
                    BigInteger number)
```
    Bind a positional BigDecimal-valued parameter.
    
    Parameters:
    
    position - The parameter position
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setDate
```
Query setDate(int position,
              Date date)
```
    Bind a positional Date-valued parameter using just the Date portion.
    
    Parameters:
    
    position - The parameter position
    
    date - The bind value
    
    Returns:
    
    this, for method chaining
  - setTime
```
Query setTime(int position,
              Date date)
```
    Bind a positional Date-valued parameter using just the Time portion.
    
    Parameters:
    
    position - The parameter position
    
    date - The bind value
    
    Returns:
    
    this, for method chaining
  - setTimestamp
```
Query setTimestamp(int position,
                   Date date)
```
    Bind a positional Date-valued parameter using the full Timestamp.
    
    Parameters:
    
    position - The parameter position
    
    date - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendar
```
Query setCalendar(int position,
                  Calendar calendar)
```
    Bind a positional Calendar-valued parameter using the full Timestamp portion.
    
    Parameters:
    
    position - The parameter position
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendarDate
```
Query setCalendarDate(int position,
                      Calendar calendar)
```
    Bind a positional Calendar-valued parameter using just the Date portion.
    
    Parameters:
    
    position - The parameter position
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setString
```
Query setString(String name,
                String val)
```
    Bind a named String-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setCharacter
```
Query setCharacter(String name,
                   char val)
```
    Bind a named char-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBoolean
```
Query setBoolean(String name,
                 boolean val)
```
    Bind a named boolean-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setByte
```
Query setByte(String name,
              byte val)
```
    Bind a named byte-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setShort
```
Query setShort(String name,
               short val)
```
    Bind a named short-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setInteger
```
Query setInteger(String name,
                 int val)
```
    Bind a named int-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setLong
```
Query setLong(String name,
              long val)
```
    Bind a named long-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setFloat
```
Query setFloat(String name,
               float val)
```
    Bind a named float-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setDouble
```
Query setDouble(String name,
                double val)
```
    Bind a named double-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setBinary
```
Query setBinary(String name,
                byte[] val)
```
    Bind a named binary-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setText
```
Query setText(String name,
              String val)
```
    Bind a named String-valued parameter using streaming.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setSerializable
```
Query setSerializable(String name,
                      Serializable val)
```
    Bind a named binary-valued parameter using serialization.
    
    Parameters:
    
    name - The parameter name
    
    val - The bind value
    
    Returns:
    
    this, for method chaining
  - setLocale
```
Query setLocale(String name,
                Locale locale)
```
    Bind a named Locale-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    locale - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigDecimal
```
Query setBigDecimal(String name,
                    BigDecimal number)
```
    Bind a named BigDecimal-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setBigInteger
```
Query setBigInteger(String name,
                    BigInteger number)
```
    Bind a named BigInteger-valued parameter.
    
    Parameters:
    
    name - The parameter name
    
    number - The bind value
    
    Returns:
    
    this, for method chaining
  - setDate
```
Query setDate(String name,
              Date date)
```
    Bind the date (time is truncated) of a given Date object to a named query parameter.
    
    Parameters:
    
    name - The name of the parameter
    
    date - The date object
    
    Returns:
    
    this, for method chaining
  - setTime
```
Query setTime(String name,
              Date date)
```
    Bind the time (date is truncated) of a given Date object to a named query parameter.
    
    Parameters:
    
    name - The name of the parameter
    
    date - The date object
    
    Returns:
    
    this, for method chaining
  - setTimestamp
```
Query setTimestamp(String name,
                   Date date)
```
    Bind the date and the time of a given Date object to a named query parameter.
    
    Parameters:
    
    name - The name of the parameter
    
    date - The date object
    
    Returns:
    
    this, for method chaining
  - setCalendar
```
Query setCalendar(String name,
                  Calendar calendar)
```
    Bind a named Calendar-valued parameter using the full Timestamp.
    
    Parameters:
    
    name - The parameter name
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setCalendarDate
```
Query setCalendarDate(String name,
                      Calendar calendar)
```
    Bind a named Calendar-valued parameter using just the Date portion.
    
    Parameters:
    
    name - The parameter name
    
    calendar - The bind value
    
    Returns:
    
    this, for method chaining
  - setEntity
```
Query setEntity(int position,
                Object val)
```
    Bind an instance of a mapped persistent class to a JDBC-style query parameter. Use setParameter(int, Object) for null values.
    
    Parameters:
    
    position - the position of the parameter in the query string, numbered from 0.
    
    val - a non-null instance of a persistent class
    
    Returns:
    
    this, for method chaining
  - setEntity
```
Query setEntity(String name,
                Object val)
```
    Bind an instance of a mapped persistent class to a named query parameter. Use setParameter(String, Object) for null values.
    
    Parameters:
    
    name - the name of the parameter
    
    val - a non-null instance of a persistent class
    
    Returns:
    
    this, for method chaining
  - setResultTransformer
```
Query setResultTransformer(ResultTransformer transformer)
```
    Set a strategy for handling the query results. This can be used to change "shape" of the query result.
    
    Parameters:
    
    transformer - The transformer to apply
    
    Returns:
    
    this (for method chaining)

Interface Query

Method Summary

Methods inherited from interface org.hibernate.BasicQueryContract

Method Detail

getQueryString

getMaxResults

setMaxResults

getFirstResult

setFirstResult

setFlushMode

setCacheMode

setCacheable

setCacheRegion

setTimeout

setFetchSize

setReadOnly

getLockOptions

setLockOptions

setLockMode

getComment

setComment

addQueryHint

getReturnAliases

getNamedParameters

iterate

scroll

scroll

list

uniqueResult

executeUpdate

setParameter

setParameter

setParameter

setParameter

setParameters

setParameterList

setParameterList

setParameterList

setParameterList

setProperties

setProperties

setString

setCharacter

setBoolean

setByte

setShort

setInteger

setLong

setFloat

setDouble

setBinary

setText

setSerializable

setLocale

setBigDecimal

setBigInteger

setDate

setTime

setTimestamp

setCalendar

setCalendarDate

setString

setCharacter

setBoolean

setByte

setShort

setInteger

setLong

setFloat

setDouble

setBinary

setText

setSerializable

setLocale

setBigDecimal

setBigInteger

setDate

setTime

setTimestamp

setCalendar