Package org.hibernate.query.sqm

Interface SqmSelectionQuery<R>

All Superinterfaces:

CommonQueryContract, SelectionQuery<R>, SqmQuery<R>

All Known Subinterfaces:

SqmSelectionQueryImplementor<R>

All Known Implementing Classes:

DelegatingSqmSelectionQueryImplementor, SqmSelectionQueryImpl

public interface SqmSelectionQuery<R>
extends SqmQuery<R>, SelectionQuery<R>

Method Summary

Modifier and Type	Method	Description
SqmSelectionQuery<R>	setCacheable(boolean cacheable)	Enable/disable second level query (result) caching for this query.
SqmSelectionQuery<R>	setCacheMode(CacheMode cacheMode)	Set the current CacheMode in effect for this query.
SqmSelectionQuery<R>	setCacheRegion(String cacheRegion)	Set the name of the cache region where query results should be cached (assuming SelectionQuery.isCacheable()).
SqmSelectionQuery<R>	setFetchSize(int fetchSize)	Sets a JDBC fetch size hint for the query.
SqmSelectionQuery<R>	setHibernateFlushMode(FlushMode flushMode)	Deprecated.
SqmSelectionQuery<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
SqmSelectionQuery<R>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQuery<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameter(int position, P value, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmSelectionQuery<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<T> SqmSelectionQuery<R>	setParameter(Parameter<T> param, T value)
SqmSelectionQuery<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
SqmSelectionQuery<R>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
SqmSelectionQuery<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> SqmSelectionQuery<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameter(String name, P value, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
<P> SqmSelectionQuery<R>	setParameter(QueryParameter<P> parameter, P val, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmSelectionQuery<R>	setParameter(QueryParameter<P> parameter, P value, Class<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use.
<T> SqmSelectionQuery<R>	setParameter(QueryParameter<T> parameter, T value)	Bind an argument to the query parameter represented by the given QueryParameter.
SqmSelectionQuery<R>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
SqmSelectionQuery<R>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> SqmSelectionQuery<R>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(int position, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
<P> SqmSelectionQuery<R>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(int position, P[] values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type.
SqmSelectionQuery<R>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
SqmSelectionQuery<R>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> SqmSelectionQuery<R>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(String name, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).
<P> SqmSelectionQuery<R>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(String name, P[] values, Class<P> javaType)	Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values, Type<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.
<P> SqmSelectionQuery<R>	setParameterList(QueryParameter<P> parameter, P[] values, Class<P> javaType)	Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use.
SqmSelectionQuery<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.
SqmSelectionQuery<R>	setProperties(Map bean)	Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
SqmSelectionQuery<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
SqmSelectionQuery<R>	setReadOnly(boolean readOnly)	Set the read-only/modifiable mode for entities and proxies loaded by this Query.
SqmSelectionQuery<R>	setResultListTransformer(ResultListTransformer<R> transformer)	Set a ResultListTransformer.
SqmSelectionQuery<R>	setTimeout(int timeout)	Set the query timeout in seconds.
<T> SqmSelectionQuery<T>	setTupleTransformer(TupleTransformer<T> transformer)	Set a TupleTransformer.

Methods inherited from interface org.hibernate.query.CommonQueryContract

getComment, getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout, setTimeout

Methods inherited from interface org.hibernate.query.SelectionQuery

disableFetchProfile, enableFetchProfile, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getKeyedResultList, getLockMode, getLockOptions, getMaxResults, getResultCount, getResultList, getResultStream, getSingleResult, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, list, scroll, scroll, setCacheRetrieveMode, setCacheStoreMode, setComment, setEntityGraph, setFirstResult, setFlushMode, setFollowOnLocking, setFollowOnStrategy, setHibernateLockMode, setHint, setLockMode, setLockMode, setLockScope, setLockScope, setMaxResults, setPage, setQueryPlanCacheable, stream, uniqueResult, uniqueResultOptional

Methods inherited from interface org.hibernate.query.spi.SqmQuery

getParameterMetadata, getQueryOptions, getQueryString, getSqmStatement

Method Details

setParameter

SqmSelectionQuery<R> setParameter(String name,
 Object value)

Description copied from interface: CommonQueryContract

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 overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, Type)
• TypedParameterValue

setParameter

<P> SqmSelectionQuery<R> setParameter(String name,
 P value,
 Class<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(String, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Type)

setParameter

<P> SqmSelectionQuery<R> setParameter(String name,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(String name,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

Bind an Instant 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 SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(String name,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(String name,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

SqmSelectionQuery<R> setParameter(int position,
 Object value)

Description copied from interface: CommonQueryContract

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 overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, Type)
• TypedParameterValue

setParameter

<P> SqmSelectionQuery<R> setParameter(int position,
 P value,
 Class<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(int, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

<P> SqmSelectionQuery<R> setParameter(int position,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(int position,
 Instant value,
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(int position,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(int position,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

<T> SqmSelectionQuery<R> setParameter(QueryParameter<T> parameter,
 T value)

Description copied from interface: CommonQueryContract

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 overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

<P> SqmSelectionQuery<R> setParameter(QueryParameter<P> parameter,
 P value,
 Class<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameter(QueryParameter, Object).

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

<P> SqmSelectionQuery<R> setParameter(QueryParameter<P> parameter,
 P val,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

<T> SqmSelectionQuery<R> setParameter(Parameter<T> param,
 T value)

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
SqmSelectionQuery<R> setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface SqmQuery<R>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

SqmSelectionQuery<R> setParameterList(String name,
 Collection values)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(String name,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to infer the Type If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, java.util.Collection, Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(String name,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

SqmSelectionQuery<R> setParameterList(String name,
 Object[] values)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(String name,
 P[] values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Class reference to attempt to determine the Type to use. If unable to determine an appropriate Type, CommonQueryContract.setParameterList(String, Collection) is used

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(java.lang.String, Object[], Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(String name,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

SqmSelectionQuery<R> setParameterList(int position,
 Collection values)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(int position,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(int position,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

SqmSelectionQuery<R> setParameterList(int position,
 Object[] values)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(int position,
 P[] values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the Type. If unable to infer an appropriate Type, fall back to CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Object[], Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(int position,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, java.util.Collection, Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 P[] values)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Class<P> javaType)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter using the given Class reference to attempt to infer the Type to use. If unable to infer an appropriate Type, fall back to using CommonQueryContract.setParameterList(String, Collection).

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(QueryParameter, Object[], Type)

setParameterList

<P> SqmSelectionQuery<R> setParameterList(QueryParameter<P> parameter,
 P[] values,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the Type.

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface SelectionQuery<R>

Specified by:

setParameterList in interface SqmQuery<R>

Returns:

this, for method chaining

setProperties

SqmSelectionQuery<R> setProperties(Object bean)

Description copied from interface: CommonQueryContract

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 SelectionQuery<R>

Specified by:

setProperties in interface SqmQuery<R>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

SqmSelectionQuery<R> setProperties(Map bean)

Description copied from interface: CommonQueryContract

Bind the values of the given Map to 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 SelectionQuery<R>

Specified by:

setProperties in interface SqmQuery<R>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setHibernateFlushMode

@Deprecated(since="7")
SqmSelectionQuery<R> setHibernateFlushMode(FlushMode flushMode)

Deprecated.

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 SelectionQuery<R>

Specified by:

setHibernateFlushMode in interface SqmQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• CommonQueryContract.getHibernateFlushMode()
• Session.getHibernateFlushMode()

setQueryFlushMode

SqmSelectionQuery<R> setQueryFlushMode(QueryFlushMode queryFlushMode)

Description copied from interface: CommonQueryContract

Set the QueryFlushMode to use for this query.

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface SelectionQuery<R>

Specified by:

setQueryFlushMode in interface SqmQuery<R>

See Also:

• Session.getHibernateFlushMode()

setCacheMode

SqmSelectionQuery<R> setCacheMode(CacheMode cacheMode)

Description copied from interface: SelectionQuery

Set the current CacheMode in effect for this query.

Set it to null to indicate that the CacheMode of the session should be used.

Specified by:

setCacheMode in interface SelectionQuery<R>

See Also:

• SelectionQuery.getCacheMode()
• Session.setCacheMode(CacheMode)

setCacheable

SqmSelectionQuery<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

SqmSelectionQuery<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()

setTimeout

SqmSelectionQuery<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, although certain "magic values" are handled - see Timeouts.NO_WAIT.

A value of zero indicates no timeout.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface SelectionQuery<R>

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

• Timeouts
• CommonQueryContract.setTimeout(Timeout)
• CommonQueryContract.getTimeout()

setFetchSize

SqmSelectionQuery<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

SqmSelectionQuery<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

setTupleTransformer

<T> SqmSelectionQuery<T> setTupleTransformer(TupleTransformer<T> transformer)

Description copied from interface: SelectionQuery

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface SelectionQuery<R>

setResultListTransformer

SqmSelectionQuery<R> setResultListTransformer(ResultListTransformer<R> transformer)

Description copied from interface: SelectionQuery

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface SelectionQuery<R>