Type Parameters:

R - The result type, for typed queries, or Object for untyped queries

All Superinterfaces:

CommonQueryContract, MutationQuery, Query, SelectionQuery<R>, TypedQuery<R>

All Known Subinterfaces:

NativeQuery<T>, NativeQueryImplementor<R>, ProcedureCallImplementor<R>, QueryImplementor<R>, SqmQueryImplementor<R>

All Known Implementing Classes:

AbstractQuery, NativeQueryImpl, ProcedureCallImpl, QuerySqmImpl
```
@Incubating
public interface Query<R>
extends SelectionQuery<R>, MutationQuery, TypedQuery<R>
```
Within the context of an active session, an instance of this type represents an executable query, either:
- a query written in HQL,
- a named query written in HQL or native SQL, or
- a criteria query.
The subtype NativeQuery represents a query written in native SQL.
This type simply mixes the TypedQuery interface defined by JPA with SelectionQuery and MutationQuery. Unfortunately, JPA does not distinguish between selection queries and mutation queries, so we lose that distinction here. However, every Query may logically be classified as one or the other.
A Query may be obtained from the Session by calling:
- QueryProducer.createQuery(String, Class), passing the HQL as a string,
- QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaQuery), passing a criteria object, or
- QueryProducer.createNamedQuery(String, Class) passing the name of a query defined using NamedQuery or NamedNativeQuery.
A Query controls how a query is executed, and allows arguments to be bound to its parameters.
- Selection queries are usually executed using getResultList() or getSingleResult().
- The methods setMaxResults(int) and setFirstResult(int) control limits and pagination.
- The various overloads of setParameter(String, Object) and setParameter(int, Object) allow arguments to be bound to named and ordinal parameters defined by the query.
Note that this interface offers no real advantages over SelectionQuery except for compatibility with the JPA-defined TypedQuery interface.
See Also:

QueryProducer

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`Query<R>`	`addQueryHint(String hint)`	Add a database query hint to the SQL query.
`default Query<R>`	`applyFetchGraph(RootGraph graph)`	Apply the given graph using fetch semantics.
`Query<R>`	`applyGraph(RootGraph graph, GraphSemantic semantic)`	Apply the given graph using the given semantic
`default Query<R>`	`applyLoadGraph(RootGraph graph)`	Apply the given graph using load semantics.
`Query<R>`	`disableFetchProfile(String profileName)`	Disable the `fetch profile` with the given name in this session.
`Query<R>`	`enableFetchProfile(String profileName)`	Enable the `fetch profile` for this query.
`int`	`executeUpdate()`	Execute an insert, update, or delete statement, and return the number of affected entities.
`String`	`getComment()`	Obtain the comment currently associated with this query.
`LockOptions`	`getLockOptions()`	Obtains the `LockOptions` in effect for this query.
`ParameterMetadata`	`getParameterMetadata()`	Access to information about query parameters.
`QueryOptions`	`getQueryOptions()`	Get the execution options for this `Query`.
`String`	`getQueryString()`	The query as a string, or `null` in the case of a criteria query.
`default List<R>`	`getResultList()`	Execute the query and return the query results as a `List`.
`default Stream<R>`	`getResultStream()`	Execute the query and return the query results as a `Stream`.
`SharedSessionContract`	`getSession()`	Get the `QueryProducer` which produced this `Query`, that is, the `Session` or `StatelessSession` that was used to create this `Query` instance.
`R`	`getSingleResult()`	Execute the query and return the single result of the query, throwing an exception if the query returns no results.
`List<R>`	`list()`	Execute the query and return the query results as a `List`.
`ScrollableResults<R>`	`scroll()`	Execute the query and return the results in a scrollable form.
`ScrollableResults<R>`	`scroll(ScrollMode scrollMode)`	Execute the query and return the results in a scrollable form.
`Query<R>`	`setCacheable(boolean cacheable)`	Enable/disable second level query (result) caching for this query.
`Query<R>`	`setCacheMode(CacheMode cacheMode)`	Set the current `CacheMode` in effect for this query.
`Query<R>`	`setCacheRegion(String cacheRegion)`	Set the name of the cache region where query results should be cached (assuming `SelectionQuery.isCacheable()`).
`Query<R>`	`setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)`
`Query<R>`	`setCacheStoreMode(CacheStoreMode cacheStoreMode)`
`Query<R>`	`setComment(String comment)`	Set the comment for this query.
`Query<R>`	`setEntityGraph(EntityGraph<R> graph, GraphSemantic semantic)`	Apply an `EntityGraph` to the query.
`Query<R>`	`setFetchSize(int fetchSize)`	Sets a JDBC fetch size hint for the query.
`Query<R>`	`setFirstResult(int startPosition)`	Set the first row position to return from the query results.
`Query<R>`	`setFlushMode(FlushModeType flushMode)`	Set the `FlushMode` in to use for this query.
`Query<R>`	`setHibernateFlushMode(FlushMode flushMode)`	Set the current `FlushMode` in effect for this query.
`Query<R>`	`setHint(String hintName, Object value)`	Set a hint.
`Query<R>`	`setLockMode(LockModeType lockMode)`	Specify the root `LockModeType` for the query
`Query<R>`	`setLockMode(String alias, LockMode lockMode)`	Set the `LockMode` to use for particular alias defined in the `FROM` clause of the query.
`Query<R>`	`setLockOptions(LockOptions lockOptions)`	Apply the given lock options to this query.
`Query<R>`	`setMaxResults(int maxResult)`	Set the max number of rows requested for the query results.
`Query<R>`	`setOrder(List<Order<? super R>> orderList)`	If the result type of this query is an entity class, add one or more rules for ordering the query results.
`Query<R>`	`setOrder(Order<? super R> order)`	If the result type of this query is an entity class, add a rule for ordering the query results.
`default Query<R>`	`setPage(Page page)`	Set the page of results to return.
`Query<R>`	`setParameter(int parameter, Object argument)`	Bind the given argument to an ordinal query parameter.
`Query<R>`	`setParameter(int parameter, Instant argument, TemporalType temporalType)`	Bind an `Instant` value to the ordinal query parameter using just the portion indicated by the given `TemporalType`.
`Query<R>`	`setParameter(int parameter, Calendar argument, TemporalType temporalType)`	`Query` override
`Query<R>`	`setParameter(int parameter, Date argument, TemporalType temporalType)`	`Query` override
`<P> Query<R>`	`setParameter(int parameter, P argument, Class<P> type)`	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameter(int parameter, P argument, BindableType<P> type)`	Bind the given argument to an ordinal query parameter using the given `BindableType`.
`Query<R>`	`setParameter(Parameter<Calendar> parameter, Calendar argument, TemporalType temporalType)`	`Query` override
`Query<R>`	`setParameter(Parameter<Date> parameter, Date argument, TemporalType temporalType)`	`Query` override
`<T> Query<R>`	`setParameter(Parameter<T> parameter, T argument)`	`Query` override
`Query<R>`	`setParameter(String parameter, Object argument)`	Bind the given argument to a named query parameter.
`Query<R>`	`setParameter(String parameter, Instant argument, TemporalType temporalType)`	Bind an `Instant` value to the named query parameter using just the portion indicated by the given `TemporalType`.
`Query<R>`	`setParameter(String parameter, Calendar argument, TemporalType temporalType)`	`Query` override
`Query<R>`	`setParameter(String parameter, Date argument, TemporalType temporalType)`	`Query` override
`<P> Query<R>`	`setParameter(String parameter, P argument, Class<P> type)`	Bind the given argument to a named query parameter using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameter(String parameter, P argument, BindableType<P> type)`	Bind the given argument to a named query parameter using the given `BindableType`.
`<P> Query<R>`	`setParameter(QueryParameter<P> parameter, P argument, Class<P> type)`	Bind an argument to the query parameter represented by the given `QueryParameter` using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameter(QueryParameter<P> parameter, P argument, BindableType<P> type)`	Bind an argument to the query parameter represented by the given `QueryParameter` using the given `BindableType`.
`<T> Query<R>`	`setParameter(QueryParameter<T> parameter, T argument)`	Bind an argument to the query parameter represented by the given `QueryParameter`.
`Query<R>`	`setParameterList(int parameter, Object[] arguments)`	Bind multiple arguments to an ordinal query parameter.
`Query<R>`	`setParameterList(int parameter, Collection arguments)`	Bind multiple arguments to an ordinal query parameter.
`<P> Query<R>`	`setParameterList(int parameter, Collection<? extends P> arguments, Class<P> javaType)`	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameterList(int parameter, Collection<? extends P> arguments, BindableType<P> type)`	Bind multiple arguments to an ordinal query parameter using the given `BindableType`.
`<P> Query<R>`	`setParameterList(int parameter, P[] arguments, Class<P> javaType)`	Bind multiple arguments to an ordinal query parameter using the given `Class` reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameterList(int parameter, P[] arguments, BindableType<P> type)`	Bind multiple arguments to an ordinal query parameter using the given `BindableType`.
`Query<R>`	`setParameterList(String parameter, Object[] values)`	Bind multiple arguments to a named query parameter.
`Query<R>`	`setParameterList(String parameter, Collection arguments)`	Bind multiple arguments to a named query parameter.
`<P> Query<R>`	`setParameterList(String parameter, Collection<? extends P> arguments, Class<P> javaType)`	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameterList(String parameter, Collection<? extends P> arguments, BindableType<P> type)`	Bind multiple arguments to a named query parameter using the given `BindableType`.
`<P> Query<R>`	`setParameterList(String parameter, P[] arguments, Class<P> javaType)`	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameterList(String parameter, P[] arguments, BindableType<P> type)`	Bind multiple arguments to a named query parameter using the given `BindableType`.
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments)`	Bind multiple arguments to the query parameter represented by the given `QueryParameter`.
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, Class<P> javaType)`	Bind multiple arguments to the query parameter represented by the given `QueryParameter` using the given Class reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, Collection<? extends P> arguments, BindableType<P> type)`	Bind multiple arguments to the query parameter represented by the given `QueryParameter`, inferring the `BindableType`.
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, P[] arguments)`	Bind multiple arguments to the query parameter represented by the given `QueryParameter`.
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, P[] arguments, Class<P> javaType)`	Bind multiple arguments to the query parameter represented by the given `QueryParameter` using the given `Class` reference to attempt to determine the `BindableType` to use.
`<P> Query<R>`	`setParameterList(QueryParameter<P> parameter, P[] arguments, BindableType<P> type)`	Bind multiple arguments to the query parameter represented by the given `QueryParameter`, inferring the `BindableType`.
`Query<R>`	`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<R>`	`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<R>`	`setReadOnly(boolean readOnly)`	Set the read-only/modifiable mode for entities and proxies loaded by this `Query`.
`Query<R>`	`setResultListTransformer(ResultListTransformer<R> transformer)`	Set a `ResultListTransformer`.
`default <T> Query<T>`	`setResultTransformer(ResultTransformer<T> transformer)`	Deprecated. Use `setTupleTransformer(org.hibernate.query.TupleTransformer<T>)` or `setResultListTransformer(org.hibernate.query.ResultListTransformer<R>)`
`Query<R>`	`setTimeout(int timeout)`	Set the query timeout in seconds.
`<T> Query<T>`	`setTupleTransformer(TupleTransformer<T> transformer)`	Set a `TupleTransformer`.
`default Stream<R>`	`stream()`	Execute the query and return the query results as a `Stream`.
`R`	`uniqueResult()`	Execute the query and return the single result of the query, or `null` if the query returns no results.
`Optional<R>`	`uniqueResultOptional()`	Execute the query and return the single result of the query as an instance of `Optional`.

Methods inherited from interface org.hibernate.query.CommonQueryContract
getFlushMode, getHibernateFlushMode, getTimeout

Methods inherited from interface jakarta.persistence.Query
getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Methods inherited from interface org.hibernate.query.SelectionQuery
getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getLockMode, getMaxResults, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode, setQueryPlanCacheable

- Method Detail
 - list
```
List<R> list()
```
 Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].
 
 Specified by:
 
 list in interface SelectionQuery<R>
 
 Returns:
 
 the result list
 - getResultList
```
default List<R> getResultList()
```
 Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].
 
 Specified by:
 
 getResultList in interface Query
 
 Specified by:
 
 getResultList in interface SelectionQuery<R>
 
 Specified by:
 
 getResultList in interface TypedQuery<R>
 
 Returns:
 
 the results as a list
 
 Implementation Note:
 
 Delegates to list()
 - scroll
```
ScrollableResults<R> scroll()
```
 Execute the query and return the results in a scrollable form.
 This overload simply calls scroll(ScrollMode) using the dialect default scroll mode.
 
 Specified by:
 
 scroll in interface SelectionQuery<R>
 
 API Note:
 
 The exact behavior of this method depends somewhat on the level of JDBC driver support for scrollable ResultSets, and so is not very portable between database.
 - scroll
```
ScrollableResults<R> scroll(ScrollMode scrollMode)
```
 Execute the query and return the results in a scrollable form. The capabilities of the returned ScrollableResults depend on the specified ScrollMode.
 
 Specified by:
 
 scroll in interface SelectionQuery<R>
 
 API Note:
 
 The exact behavior of this method depends somewhat on the level of JDBC driver support for scrollable ResultSets, and so is not very portable between database.
 - getResultStream
```
default Stream<R> getResultStream()
```
 Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].
 The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.
 
 Specified by:
 
 getResultStream in interface Query
 
 Specified by:
 
 getResultStream in interface SelectionQuery<R>
 
 Specified by:
 
 getResultStream in interface TypedQuery<R>
 
 Returns:
 
 The results as a Stream
 
 Implementation Note:
 
 Delegates to stream(), which in turn delegates to this method. Implementors should implement at least one of these methods.
 - stream
```
default Stream<R> stream()
```
 Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].
 The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.
 
 Specified by:
 
 stream in interface SelectionQuery<R>
 
 Returns:
 
 The results as a Stream
 
 Since:
 
 5.2
 - uniqueResult
```
R uniqueResult()
```
 Execute the query and return the single result of the query, or null if the query returns no results.
 
 Specified by:
 
 uniqueResult in interface SelectionQuery<R>
 
 Returns:
 
 the single result or null if there is no result to return
 
 Throws:
 
 NonUniqueResultException - if there is more than one matching result
 - getSingleResult
```
R getSingleResult()
```
 Execute the query and return the single result of the query, throwing an exception if the query returns no results.
 
 Specified by:
 
 getSingleResult in interface Query
 
 Specified by:
 
 getSingleResult in interface SelectionQuery<R>
 
 Specified by:
 
 getSingleResult in interface TypedQuery<R>
 
 Returns:
 
 the single result, only if there is exactly one
 
 Throws:
 
 NonUniqueResultException - if there is more than one matching result
 
 NoResultException - if there is no result to return
 - uniqueResultOptional
```
Optional<R> uniqueResultOptional()
```
 Execute the query and return the single result of the query as an instance of Optional.
 
 Specified by:
 
 uniqueResultOptional in interface SelectionQuery<R>
 
 Returns:
 
 the single result as an Optional
 
 Throws:
 
 NonUniqueResultException - if there is more than one matching result
 - executeUpdate
```
int executeUpdate()
```
 Execute an insert, update, or delete statement, and return the number of affected entities.
 For use with instances of MutationQuery created using QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaUpdate), or QueryProducer.createQuery(jakarta.persistence.criteria.CriteriaDelete).
 
 Specified by:
 
 executeUpdate in interface MutationQuery
 
 Specified by:
 
 executeUpdate in interface Query
 
 Returns:
 
 the number of affected entity instances (may differ from the number of affected rows)
 
 See Also:
 
 QueryProducer.createMutationQuery(java.lang.String), QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String), QueryProducer.createNativeMutationQuery(String), Query.executeUpdate(), QueryProducer.createMutationQuery(java.lang.String)
 
 API Note:
 
 This method is needed because this interface extends Query, which defines this method. See MutationQuery and SelectionQuery.
 - getSession
```
SharedSessionContract getSession()
```
 Get the QueryProducer which produced this Query, that is, the Session or StatelessSession that was used to create this Query instance.
 
 Returns:
 
 The producer of this query
 - getQueryString
```
String getQueryString()
```
 The query as a string, or null in the case of a criteria query.
 - applyGraph
```
Query<R> applyGraph(RootGraph graph,
 GraphSemantic semantic)
```
 Apply the given graph using the given semantic
 
 Parameters:
 
 graph - The graph to apply.
 
 semantic - The semantic to use when applying the graph
 - applyFetchGraph
```
default Query<R> applyFetchGraph(RootGraph graph)
```
 Apply the given graph using fetch semantics.
 
 API Note:
 
 This method calls applyGraph(RootGraph, GraphSemantic) using GraphSemantic.FETCH as the semantic.
 - applyLoadGraph
```
default Query<R> applyLoadGraph(RootGraph graph)
```
 Apply the given graph using load semantics.
 
 API Note:
 
 This method calls applyGraph(RootGraph, GraphSemantic) using GraphSemantic.LOAD as the semantic.
 - getComment
```
String getComment()
```
 Obtain the comment currently associated with this query.
 If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.
 SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".
 
 Specified by:
 
 getComment in interface CommonQueryContract
 
 Returns:
 
 The comment.
 - setComment
```
Query<R> setComment(String comment)
```
 Set the comment for this query.
 If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.
 SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".
 
 Specified by:
 
 setComment in interface CommonQueryContract
 
 Specified by:
 
 setComment in interface MutationQuery
 
 Specified by:
 
 setComment in interface SelectionQuery<R>
 
 Parameters:
 
 comment - The human-readable comment
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 getComment()
 - addQueryHint
```
Query<R> addQueryHint(String hint)
```
 Add a database query hint to the SQL query.
 A database hint is a completely different concept to a JPA hint specified using QueryHint or Query.getHints(). These are hints to the JPA provider.
 Multiple query hints may be specified. The operation Dialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.
 
 Parameters:
 
 hint - The database specific query hint to add.
 - getLockOptions
```
LockOptions getLockOptions()
```
 Obtains the LockOptions in effect for this query.
 
 Specified by:
 
 getLockOptions in interface SelectionQuery<R>
 
 Returns:
 
 The LockOptions currently in effect
 
 See Also:
 
 LockOptions
 - setLockOptions
```
Query<R> setLockOptions(LockOptions lockOptions)
```
 Apply the given lock options to this query. Alias-specific lock modes in the given lock options are merged with any alias-specific lock mode which have already been set. If a lock mode has already been specified for an alias that is among the aliases in the given lock options, the lock mode specified in the given lock options overrides the lock mode that was already set.
 
 Parameters:
 
 lockOptions - The lock options to apply to the query.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 getLockOptions()
 - setLockMode
```
Query<R> setLockMode(String alias,
 LockMode lockMode)
```
 Set the LockMode to use for particular alias defined in the FROM clause of the query.
 The alias-specific lock modes specified here are added to the LockOptions.
 The effect of alias-specific locking is quite dependent on the driver and database. For maximum portability, the given lock mode should be LockMode.PESSIMISTIC_WRITE.
 
 Specified by:
 
 setLockMode in interface SelectionQuery<R>
 
 Parameters:
 
 alias - A query alias
 
 lockMode - The lock mode to apply
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 getLockOptions()
 - setTupleTransformer
```
<T> Query<T> setTupleTransformer(TupleTransformer<T> transformer)
```
 Set a TupleTransformer.
 - setResultListTransformer
```
Query<R> setResultListTransformer(ResultListTransformer<R> transformer)
```
 Set a ResultListTransformer.
 - getQueryOptions
```
QueryOptions getQueryOptions()
```
 Get the execution options for this Query. Many of the setters of this object update the state of the returned QueryOptions. This is useful because it gives access to s primitive value in its (nullable) wrapper form, rather than the primitive form as required by JPA. This allows us to distinguish whether a value has been explicitly set by the client.
 
 Returns:
 
 Return the encapsulation of this query's options.
 - getParameterMetadata
```
ParameterMetadata getParameterMetadata()
```
 Access to information about query parameters.
 
 Returns:
 
 information about query parameters.
 - setParameter
```
Query<R> setParameter(String parameter,
 Object argument)
```
 Bind the given argument to a named query parameter.
 If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms accept a "type".
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 setParameter(String, Object, Class), setParameter(String, Object, BindableType)
 - setParameter
```
 Query<R> setParameter(String parameter,
 P argument,
 Class type)
```
 Bind the given argument to a named query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameter(String, Object) is used.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 See Also:
 
 setParameter(String, Object, BindableType)
 - setParameter
```
 Query<R> setParameter(String parameter,
 P argument,
 BindableType type)
```
 Bind the given argument to a named query parameter using the given BindableType.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 - setParameter
```
Query<R> setParameter(String parameter,
 Instant argument,
 TemporalType temporalType)
```
 Bind an Instant value to the named query parameter using just the portion indicated by the given TemporalType.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 - setParameter
```
Query<R> setParameter(String parameter,
 Calendar argument,
 TemporalType temporalType)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(String, Calendar, TemporalType)
 - setParameter
```
Query<R> setParameter(String parameter,
 Date argument,
 TemporalType temporalType)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(String, Date, TemporalType)
 - setParameter
```
Query<R> setParameter(int parameter,
 Object argument)
```
 Bind the given argument to an ordinal query parameter.
 If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 setParameter(int, Object, Class), setParameter(int, Object, BindableType)
 - setParameter
```
 Query<R> setParameter(int parameter,
 P argument,
 Class type)
```
 Bind the given argument to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameter(int, Object) is used.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 See Also:
 
 setParameter(int, Object, BindableType)
 - setParameter
```
 Query<R> setParameter(int parameter,
 P argument,
 BindableType type)
```
 Bind the given argument to an ordinal query parameter using the given BindableType.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 - setParameter
```
Query<R> setParameter(int parameter,
 Instant argument,
 TemporalType temporalType)
```
 Bind an Instant value to the ordinal query parameter using just the portion indicated by the given TemporalType.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 - setParameter
```
Query<R> setParameter(int parameter,
 Date argument,
 TemporalType temporalType)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(int, Date, TemporalType)
 - setParameter
```
Query<R> setParameter(int parameter,
 Calendar argument,
 TemporalType temporalType)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(int, Calendar, TemporalType)
 - setParameter
```
<T> Query<R> setParameter(QueryParameter<T> parameter,
 T argument)
```
 Bind an argument to the query parameter represented by the given QueryParameter.
 If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Parameters:
 
 parameter - the query parameter memento
 
 argument - the argument, which might be null
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameter(QueryParameter, Object, BindableType)
 - setParameter
```
 Query<R> setParameter(QueryParameter parameter,
 P argument,
 Class type)
```
 Bind an argument to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameter(QueryParameter, Object) is used
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Parameters:
 
 parameter - the query parameter memento
 
 argument - the argument, which might be null
 
 type - a BindableType representing the type of the parameter
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameter(QueryParameter, Object, BindableType)
 - setParameter
```
 Query<R> setParameter(QueryParameter parameter,
 P argument,
 BindableType type)
```
 Bind an argument to the query parameter represented by the given QueryParameter using the given BindableType.
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Parameters:
 
 parameter - the query parameter memento
 
 argument - the argument, which might be null
 
 type - an BindableType representing the type of the parameter
 
 Returns:
 
 this, for method chaining
 - setParameter
```
<T> Query<R> setParameter(Parameter<T> parameter,
 T argument)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(Parameter, Object)
 - setParameter
```
Query<R> setParameter(Parameter<Calendar> parameter,
 Calendar argument,
 TemporalType temporalType)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(Parameter, Calendar, TemporalType)
 - setParameter
```
Query<R> setParameter(Parameter<Date> parameter,
 Date argument,
 TemporalType temporalType)
```
 Query override
 
 Specified by:
 
 setParameter in interface CommonQueryContract
 
 Specified by:
 
 setParameter in interface MutationQuery
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface SelectionQuery<R>
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 See Also:
 
 Query.setParameter(Parameter, Date, TemporalType)
 - setParameterList
```
Query<R> setParameterList(String parameter,
 Collection arguments)
```
 Bind multiple arguments to a named query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(java.lang.String, java.util.Collection, BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(String parameter,
 Collection<? extends P> arguments,
 Class javaType)
```
 Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameterList(String, Collection) is used.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(java.lang.String, java.util.Collection, BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(String parameter,
 Collection<? extends P> arguments,
 BindableType type)
```
 Bind multiple arguments to a named query parameter using the given BindableType.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
Query<R> setParameterList(String parameter,
 Object[] values)
```
 Bind multiple arguments to a named query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(String parameter,
 P[] arguments,
 Class javaType)
```
 Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameterList(String, Collection) is used.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(java.lang.String, Object[], BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(String parameter,
 P[] arguments,
 BindableType type)
```
 Bind multiple arguments to a named query parameter using the given BindableType.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
Query<R> setParameterList(int parameter,
 Collection arguments)
```
 Bind multiple arguments to an ordinal query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(int parameter,
 Collection<? extends P> arguments,
 Class javaType)
```
 Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameterList(String, Collection) is used.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(int, Collection, BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(int parameter,
 Collection<? extends P> arguments,
 BindableType type)
```
 Bind multiple arguments to an ordinal query parameter using the given BindableType.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
Query<R> setParameterList(int parameter,
 Object[] arguments)
```
 Bind multiple arguments to an ordinal query parameter.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(int parameter,
 P[] arguments,
 Class javaType)
```
 Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameterList(String, Collection) is used.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(int, Object[], BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(int parameter,
 P[] arguments,
 BindableType type)
```
 Bind multiple arguments to an ordinal query parameter using the given BindableType.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 Collection<? extends P> arguments)
```
 Bind multiple arguments to the query parameter represented by the given QueryParameter.
 The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Parameters:
 
 parameter - the parameter memento
 
 arguments - a collection of arguments
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 Collection<? extends P> arguments,
 Class javaType)
```
 Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameterList(String, Collection) is used.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(QueryParameter, java.util.Collection, BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 Collection<? extends P> arguments,
 BindableType type)
```
 Bind multiple arguments to the query parameter represented by the given QueryParameter, inferring the BindableType.
 The "type mapping" for the binding is inferred from the type of the first collection element.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 P[] arguments)
```
 Bind multiple arguments to the query parameter represented by the given QueryParameter.
 The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Parameters:
 
 parameter - the parameter memento
 
 arguments - a collection of arguments
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 P[] arguments,
 Class javaType)
```
 Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to determine the BindableType to use. If unable to determine an appropriate BindableType, setParameterList(String, Collection) is used.
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 setParameterList(QueryParameter, Object[], BindableType)
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setParameterList
```
 Query<R> setParameterList(QueryParameter parameter,
 P[] arguments,
 BindableType type)
```
 Bind multiple arguments to the query parameter represented by the given QueryParameter, inferring the BindableType.
 The "type mapping" for the binding is inferred from the type of the first collection element
 
 Specified by:
 
 setParameterList in interface CommonQueryContract
 
 Specified by:
 
 setParameterList in interface MutationQuery
 
 Specified by:
 
 setParameterList in interface SelectionQuery<R>
 
 Returns:
 
 this, for method chaining
 
 API Note:
 
 This is used for binding a list of values to an expression such as entity.field in (:values).
 - setProperties
```
Query<R> 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.
 
 Specified by:
 
 setProperties in interface CommonQueryContract
 
 Specified by:
 
 setProperties in interface MutationQuery
 
 Specified by:
 
 setProperties in interface SelectionQuery<R>
 
 Parameters:
 
 bean - any JavaBean or POJO
 
 Returns:
 
 this, for method chaining
 - setProperties
```
Query<R> 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.
 
 Specified by:
 
 setProperties in interface CommonQueryContract
 
 Specified by:
 
 setProperties in interface MutationQuery
 
 Specified by:
 
 setProperties in interface SelectionQuery<R>
 
 Parameters:
 
 bean - a Map of names to arguments
 
 Returns:
 
 this, for method chaining
 - setHibernateFlushMode
```
Query<R> setHibernateFlushMode(FlushMode flushMode)
```
 Description copied from interface: CommonQueryContract
 
 Set the current FlushMode in effect for this query.
 
 Specified by:
 
 setHibernateFlushMode in interface CommonQueryContract
 
 Specified by:
 
 setHibernateFlushMode in interface MutationQuery
 
 Specified by:
 
 setHibernateFlushMode in interface SelectionQuery<R>
 
 See Also:
 
 CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()
 - setCacheable
```
Query<R> setCacheable(boolean cacheable)
```
 Description copied from interface: SelectionQuery
 
 Enable/disable second level query (result) caching for this query.
 
 Specified by:
 
 setCacheable in interface SelectionQuery<R>
 
 See Also:
 
 SelectionQuery.isCacheable()
 - setCacheRegion
```
Query<R> setCacheRegion(String cacheRegion)
```
 Description copied from interface: SelectionQuery
 
 Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()). null indicates to use the default region.
 
 Specified by:
 
 setCacheRegion in interface SelectionQuery<R>
 
 See Also:
 
 SelectionQuery.getCacheRegion()
 - setCacheMode
```
Query<R> setCacheMode(CacheMode cacheMode)
```
 Description copied from interface: SelectionQuery
 
 Set the current CacheMode in effect for this query.
 
 Specified by:
 
 setCacheMode in interface SelectionQuery<R>
 
 See Also:
 
 SelectionQuery.getCacheMode(), Session.setCacheMode(CacheMode)
 - setCacheStoreMode
```
Query<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)
```
 Specified by:
 
 setCacheStoreMode in interface SelectionQuery<R>
 
 See Also:
 
 SelectionQuery.setCacheMode(CacheMode)
 - setCacheRetrieveMode
```
Query<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
```
 Specified by:
 
 setCacheRetrieveMode in interface SelectionQuery<R>
 
 See Also:
 
 SelectionQuery.setCacheMode(CacheMode)
 - setTimeout
```
Query<R> setTimeout(int timeout)
```
 Description copied from interface: CommonQueryContract
 
 Set the query timeout in seconds.
 Any value set here is eventually passed directly along to the JDBC statement, which expressly disallows negative values. So negative values should be avoided as a general rule.
 A value of zero indicates no timeout.
 
 Specified by:
 
 setTimeout in interface CommonQueryContract
 
 Specified by:
 
 setTimeout in interface MutationQuery
 
 Specified by:
 
 setTimeout in interface SelectionQuery<R>
 
 Parameters:
 
 timeout - the timeout in seconds
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 CommonQueryContract.getTimeout()
 - setFetchSize
```
Query<R> setFetchSize(int fetchSize)
```
 Description copied from interface: SelectionQuery
 
 Sets a JDBC fetch size hint for the query.
 
 Specified by:
 
 setFetchSize in interface SelectionQuery<R>
 
 Parameters:
 
 fetchSize - the fetch size hint
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 SelectionQuery.getFetchSize()
 - setReadOnly
```
Query<R> setReadOnly(boolean readOnly)
```
 Description copied from interface: SelectionQuery
 
 Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context, Session.isDefaultReadOnly().
 To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session, use Session.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 beforeQuery the query was executed.
 
 Specified by:
 
 setReadOnly in interface SelectionQuery<R>
 
 Parameters:
 
 readOnly - true indicates that entities and proxies loaded by the query are to be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode
 
 Returns:
 
 this, for method chaining
 - setMaxResults
```
Query<R> setMaxResults(int maxResult)
```
 Description copied from interface: SelectionQuery
 
 Set the max number of rows requested for the query results. Applied to the SQL query
 
 Specified by:
 
 setMaxResults in interface Query
 
 Specified by:
 
 setMaxResults in interface SelectionQuery<R>
 
 Specified by:
 
 setMaxResults in interface TypedQuery<R>
 - setFirstResult
```
Query<R> setFirstResult(int startPosition)
```
 Description copied from interface: SelectionQuery
 
 Set the first row position to return from the query results. Applied to the SQL query.
 
 Specified by:
 
 setFirstResult in interface Query
 
 Specified by:
 
 setFirstResult in interface SelectionQuery<R>
 
 Specified by:
 
 setFirstResult in interface TypedQuery<R>
 - setPage
```
@Incubating
default Query<R> setPage(Page page)
```
 Description copied from interface: SelectionQuery
 
 Set the page of results to return.
 
 Specified by:
 
 setPage in interface SelectionQuery<R>
 
 See Also:
 
 Page
 - setHint
```
Query<R> setHint(String hintName,
 Object value)
```
 Description copied from interface: CommonQueryContract
 
 Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.
 
 Specified by:
 
 setHint in interface CommonQueryContract
 
 Specified by:
 
 setHint in interface MutationQuery
 
 Specified by:
 
 setHint in interface Query
 
 Specified by:
 
 setHint in interface SelectionQuery<R>
 
 Specified by:
 
 setHint in interface TypedQuery<R>
 
 See Also:
 
 HibernateHints, SpecHints
 - setEntityGraph
```
Query<R> setEntityGraph(EntityGraph<R> graph,
 GraphSemantic semantic)
```
 Description copied from interface: SelectionQuery
 
 Apply an EntityGraph to the query.
 This is an alternative way to specify the associations which should be fetched as part of the initial query.
 
 Specified by:
 
 setEntityGraph in interface SelectionQuery<R>
 - enableFetchProfile
```
Query<R> enableFetchProfile(String profileName)
```
 Description copied from interface: SelectionQuery
 
 Enable the fetch profile for this query. If the requested fetch profile is already enabled, the call has no effect.
 This is an alternative way to specify the associations which should be fetched as part of the initial query.
 
 Specified by:
 
 enableFetchProfile in interface SelectionQuery<R>
 
 Parameters:
 
 profileName - the name of the fetch profile to be enabled
 
 See Also:
 
 FetchProfile
 - disableFetchProfile
```
Query<R> disableFetchProfile(String profileName)
```
 Description copied from interface: SelectionQuery
 
 Disable the fetch profile with the given name in this session. If the requested fetch profile is not currently enabled, the call has no effect.
 
 Specified by:
 
 disableFetchProfile in interface SelectionQuery<R>
 
 Parameters:
 
 profileName - the name of the fetch profile to be disabled
 
 See Also:
 
 FetchProfile
 - setFlushMode
```
Query<R> setFlushMode(FlushModeType flushMode)
```
 Description copied from interface: CommonQueryContract
 
 Set the FlushMode in to use for this query.
 
 Specified by:
 
 setFlushMode in interface CommonQueryContract
 
 Specified by:
 
 setFlushMode in interface MutationQuery
 
 Specified by:
 
 setFlushMode in interface Query
 
 Specified by:
 
 setFlushMode in interface SelectionQuery<R>
 
 Specified by:
 
 setFlushMode in interface TypedQuery<R>
 
 See Also:
 
 CommonQueryContract.getHibernateFlushMode(), Session.getHibernateFlushMode()
 - setLockMode
```
Query<R> setLockMode(LockModeType lockMode)
```
 Description copied from interface: SelectionQuery
 
 Specify the root LockModeType for the query
 
 Specified by:
 
 setLockMode in interface Query
 
 Specified by:
 
 setLockMode in interface SelectionQuery<R>
 
 Specified by:
 
 setLockMode in interface TypedQuery<R>
 
 See Also:
 
 SelectionQuery.setHibernateLockMode(org.hibernate.LockMode)
 - setOrder
```
@Incubating
Query<R> setOrder(List<Order<? super R>> orderList)
```
 Description copied from interface: SelectionQuery
 
 If the result type of this query is an entity class, add one or more rules for ordering the query results.
 
 Specified by:
 
 setOrder in interface SelectionQuery<R>
 
 Parameters:
 
 orderList - one or more instances of Order
 
 See Also:
 
 Order
 - setOrder
```
@Incubating
Query<R> setOrder(Order<? super R> order)
```
 Description copied from interface: SelectionQuery
 
 If the result type of this query is an entity class, add a rule for ordering the query results.
 
 Specified by:
 
 setOrder in interface SelectionQuery<R>
 
 Parameters:
 
 order - an instance of Order
 
 See Also:
 
 Order
 - setResultTransformer
```
@Deprecated(since="5.2")
default <T> Query<T> setResultTransformer(ResultTransformer<T> transformer)
```
 Deprecated.
 Use setTupleTransformer(org.hibernate.query.TupleTransformer<T>) or setResultListTransformer(org.hibernate.query.ResultListTransformer<R>)

Interface Query<R>

Method Summary

Methods inherited from interface org.hibernate.query.CommonQueryContract

Methods inherited from interface jakarta.persistence.Query

Methods inherited from interface org.hibernate.query.SelectionQuery

Method Detail

list

getResultList

scroll

scroll

getResultStream

stream

uniqueResult

getSingleResult

uniqueResultOptional

executeUpdate

getSession

getQueryString

applyGraph

applyFetchGraph

applyLoadGraph

getComment

setComment

addQueryHint

getLockOptions

setLockOptions

setLockMode

setTupleTransformer

setResultListTransformer

getQueryOptions

getParameterMetadata

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setProperties

setProperties

setHibernateFlushMode

setCacheable

setCacheRegion

setCacheMode

setCacheStoreMode

setCacheRetrieveMode

setTimeout

setFetchSize

setReadOnly

setMaxResults

setFirstResult