Package org.hibernate.query

Interface CommonQueryContract

All Known Subinterfaces:

MutationQuery, NativeQuery<T>, NativeQueryImplementor<R>, ProcedureCall, ProcedureCallImplementor<R>, Query<R>, QueryImplementor<R>, SelectionQuery<R>, SqmQuery, SqmQueryImplementor<R>, SqmSelectionQuery<R>, SqmSelectionQueryImplementor<R>

All Known Implementing Classes:

AbstractCommonQueryContract, AbstractQuery, AbstractSelectionQuery, DelegatingSqmSelectionQueryImplementor, NativeQueryImpl, ProcedureCallImpl, QuerySqmImpl, SqmSelectionQueryImpl

public interface CommonQueryContract

Defines the aspects of query execution and parameter binding that apply to all forms of querying: HQL/JPQL queries, native SQL queries, criteria queries, and stored procedure calls.

Queries may have parameters, either ordinal or named, and the various setParameter() operations of this interface allow an argument to be bound to a parameter. It's not usually necessary to explicitly specify the type of an argument, but in rare cases where this is needed, TypedParameterValue may be used.

The operation setFlushMode(FlushModeType) allows a temporary flush mode to be specified, which is in effect only during the execution of this query. Setting the flush mode at the query level does not affect the flush mode of other operations performed via the parent session. This operation is usually used as follows:

query.setFlushMode(COMMIT).getResultList()

The call to setFlushMode(COMMIT) disables the usual automatic flush operation that occurs before query execution.

See Also:

• Query
• SelectionQuery
• MutationQuery

Method Summary

Modifier and Type	Method	Description
String	getComment()	Get the comment that has been set for this query, if any.
FlushModeType	getFlushMode()	Deprecated. use getQueryFlushMode()
FlushMode	getHibernateFlushMode()	Deprecated. use getQueryFlushMode()
QueryFlushMode	getQueryFlushMode()	The QueryFlushMode in effect for this query.
Integer	getTimeout()	Obtain the query timeout in seconds.
CommonQueryContract	setComment(String comment)	Set a comment for this query.
CommonQueryContract	setFlushMode(FlushModeType flushMode)	Deprecated. use setQueryFlushMode(QueryFlushMode)
CommonQueryContract	setHibernateFlushMode(FlushMode flushMode)	Deprecated. use setQueryFlushMode(QueryFlushMode)
CommonQueryContract	setHint(String hintName, Object value)	Set a hint.
CommonQueryContract	setParameter(int parameter, Object value)	Bind the given argument to an ordinal query parameter.
CommonQueryContract	setParameter(int parameter, Instant value, TemporalType temporalType)	Bind an Instant to an ordinal query parameter using just the portion indicated by the given TemporalType.
CommonQueryContract	setParameter(int parameter, Calendar value, TemporalType temporalType)
CommonQueryContract	setParameter(int parameter, Date value, TemporalType temporalType)
<P> CommonQueryContract	setParameter(int parameter, P value, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
<P> CommonQueryContract	setParameter(int parameter, P value, BindableType<P> type)	Bind the given argument to an ordinal query parameter using the given BindableType.
CommonQueryContract	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)
CommonQueryContract	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)
<T> CommonQueryContract	setParameter(Parameter<T> param, T value)
CommonQueryContract	setParameter(String parameter, Object value)	Bind the given argument to a named query parameter.
CommonQueryContract	setParameter(String parameter, Instant value, TemporalType temporalType)	Bind an Instant to the named query parameter using just the portion indicated by the given TemporalType.
CommonQueryContract	setParameter(String parameter, Calendar value, TemporalType temporalType)
CommonQueryContract	setParameter(String parameter, Date value, TemporalType temporalType)
<P> CommonQueryContract	setParameter(String parameter, P value, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the BindableType.
<P> CommonQueryContract	setParameter(String parameter, P value, BindableType<P> type)	Bind the given argument to a named query parameter using the given BindableType.
<P> CommonQueryContract	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 BindableType to use.
<P> CommonQueryContract	setParameter(QueryParameter<P> parameter, P val, BindableType<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given BindableType.
<T> CommonQueryContract	setParameter(QueryParameter<T> parameter, T value)	Bind an argument to the query parameter represented by the given QueryParameter.
CommonQueryContract	setParameterList(int parameter, Object[] values)	Bind multiple arguments to an ordinal query parameter.
CommonQueryContract	setParameterList(int parameter, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> CommonQueryContract	setParameterList(int parameter, 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 BindableType.
<P> CommonQueryContract	setParameterList(int parameter, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to an ordinal query parameter using the given BindableType.
<P> CommonQueryContract	setParameterList(int parameter, P[] values, Class<P> javaType)	Bind multiple arguments to an ordinal query parameter using the given Class reference to attempt to infer the BindableType.
<P> CommonQueryContract	setParameterList(int parameter, P[] values, BindableType<P> type)	Bind multiple arguments to an ordinal query parameter using the given BindableType.
CommonQueryContract	setParameterList(String parameter, Object[] values)	Bind multiple arguments to a named query parameter.
CommonQueryContract	setParameterList(String parameter, Collection values)	Bind multiple arguments to a named query parameter.
<P> CommonQueryContract	setParameterList(String parameter, 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 BindableType If unable to infer an appropriate BindableType, fall back to setParameterList(String, Collection).
<P> CommonQueryContract	setParameterList(String parameter, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to a named query parameter using the given BindableType.
<P> CommonQueryContract	setParameterList(String parameter, P[] values, 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> CommonQueryContract	setParameterList(String parameter, P[] values, BindableType<P> type)	Bind multiple arguments to a named query parameter using the given BindableType.
<P> CommonQueryContract	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> CommonQueryContract	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 BindableType to use.
<P> CommonQueryContract	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values, BindableType<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given BindableType.
<P> CommonQueryContract	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> CommonQueryContract	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 BindableType to use.
<P> CommonQueryContract	setParameterList(QueryParameter<P> parameter, P[] values, BindableType<P> type)	Bind multiple arguments to the query parameter represented by the given QueryParameter, using the given the BindableType.
CommonQueryContract	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.
CommonQueryContract	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.
CommonQueryContract	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
CommonQueryContract	setTimeout(int timeout)	Set the query timeout in seconds.

Method Details

getQueryFlushMode

QueryFlushMode getQueryFlushMode()

The QueryFlushMode in effect for this query.

By default, this is QueryFlushMode.DEFAULT, and the FlushMode of the owning Session determines whether it is flushed.

Since:

7.0

See Also:

• Session.getHibernateFlushMode()

setQueryFlushMode

CommonQueryContract setQueryFlushMode(QueryFlushMode queryFlushMode)

Set the QueryFlushMode to use for this query.

Since:

7.0

See Also:

• Session.getHibernateFlushMode()

getFlushMode

@Deprecated(since="7")
FlushModeType getFlushMode()

Deprecated.

use getQueryFlushMode()

The JPA FlushModeType in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.

See Also:

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

setFlushMode

@Deprecated(since="7")
CommonQueryContract setFlushMode(FlushModeType flushMode)

Deprecated.

use setQueryFlushMode(QueryFlushMode)

Set the FlushMode to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use setHibernateFlushMode(org.hibernate.FlushMode) passing FlushMode.MANUAL instead to indicate that no automatic flushing should occur.

See Also:

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

getHibernateFlushMode

@Deprecated(since="7")
FlushMode getHibernateFlushMode()

Deprecated.

use getQueryFlushMode()

The FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.

See Also:

• getQueryFlushMode()
• Session.getHibernateFlushMode()

setHibernateFlushMode

@Deprecated(since="7")
CommonQueryContract setHibernateFlushMode(FlushMode flushMode)

Deprecated.

use setQueryFlushMode(QueryFlushMode)

Set the current FlushMode in effect for this query.

See Also:

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

Implementation Note:

Setting to null ultimately indicates to use the FlushMode of the session. Use FlushMode.MANUAL instead to indicate that no automatic flushing should occur.

getTimeout

Integer getTimeout()

Obtain the query timeout in seconds.

This value is eventually passed along to the JDBC statement via Statement.setQueryTimeout(int).

A value of zero indicates no timeout.

See Also:

• Statement.getQueryTimeout()
• Statement.setQueryTimeout(int)

setTimeout

CommonQueryContract setTimeout(int timeout)

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.

Parameters:

timeout - the timeout in seconds

Returns:

this, for method chaining

See Also:

• getTimeout()

getComment

String getComment()

Get the comment that has been set for this query, if any.

setComment

CommonQueryContract setComment(String comment)

Set a comment for this query.

See Also:

• Query.setComment(String)

setHint

CommonQueryContract setHint(String hintName,
 Object value)

Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.

See Also:

• HibernateHints
• SpecHints

setParameter

CommonQueryContract setParameter(String parameter,
 Object value)

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

See Also:

• setParameter(String, Object, Class)
• setParameter(String, Object, BindableType)

setParameter

<P> CommonQueryContract setParameter(String parameter,
 P value,
 Class<P> type)

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

See Also:

• setParameter(String, Object, BindableType)

setParameter

<P> CommonQueryContract setParameter(String parameter,
 P value,
 BindableType<P> type)

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

setParameter

CommonQueryContract setParameter(String parameter,
 Instant value,
 TemporalType temporalType)

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

setParameter

CommonQueryContract setParameter(String parameter,
 Calendar value,
 TemporalType temporalType)

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

CommonQueryContract setParameter(String parameter,
 Date value,
 TemporalType temporalType)

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

CommonQueryContract setParameter(int parameter,
 Object value)

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".

See Also:

• setParameter(int, Object, Class)
• setParameter(int, Object, BindableType)

setParameter

<P> CommonQueryContract setParameter(int parameter,
 P value,
 Class<P> type)

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

See Also:

• setParameter(int, Object, BindableType)

setParameter

<P> CommonQueryContract setParameter(int parameter,
 P value,
 BindableType<P> type)

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

setParameter

CommonQueryContract setParameter(int parameter,
 Instant value,
 TemporalType temporalType)

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

setParameter

CommonQueryContract setParameter(int parameter,
 Date value,
 TemporalType temporalType)

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

CommonQueryContract setParameter(int parameter,
 Calendar value,
 TemporalType temporalType)

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

<T> CommonQueryContract setParameter(QueryParameter<T> parameter,
 T value)

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".

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• setParameter(QueryParameter, Object, BindableType)

setParameter

<P> CommonQueryContract 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 BindableType to use. If unable to infer an appropriate BindableType, fall back to setParameter(QueryParameter, Object).

Parameters:

parameter - the query parameter memento

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

<P> CommonQueryContract setParameter(QueryParameter<P> parameter,
 P val,
 BindableType<P> type)

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

Parameters:

parameter - the query parameter memento

val - the argument, which might be null

type - a BindableType representing the type of the parameter

Returns:

this, for method chaining

setParameter

<T> CommonQueryContract setParameter(Parameter<T> param,
 T value)

See Also:

• Query.setParameter(Parameter, Object)

setParameter

CommonQueryContract setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

CommonQueryContract setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

CommonQueryContract setParameterList(String parameter,
 Collection 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.

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

<P> CommonQueryContract setParameterList(String parameter,
 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 BindableType If unable to infer an appropriate BindableType, fall back to setParameterList(String, Collection).

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

<P> CommonQueryContract setParameterList(String parameter,
 Collection<? extends P> values,
 BindableType<P> type)

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

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

CommonQueryContract 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

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

<P> CommonQueryContract setParameterList(String parameter,
 P[] values,
 Class<P> 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

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

<P> CommonQueryContract setParameterList(String parameter,
 P[] values,
 BindableType<P> type)

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

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

CommonQueryContract setParameterList(int parameter,
 Collection values)

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

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

<P> CommonQueryContract setParameterList(int parameter,
 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 BindableType. If unable to infer an appropriate BindableType, fall back to setParameterList(String, Collection).

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

<P> CommonQueryContract setParameterList(int parameter,
 Collection<? extends P> values,
 BindableType<P> type)

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

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

CommonQueryContract setParameterList(int parameter,
 Object[] values)

Bind multiple arguments to an ordinal query parameter.

The "type mapping" for the binding is inferred from the type of the first collection element

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

<P> CommonQueryContract setParameterList(int parameter,
 P[] values,
 Class<P> javaType)

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

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

<P> CommonQueryContract setParameterList(int parameter,
 P[] values,
 BindableType<P> type)

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

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

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

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.

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> CommonQueryContract 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 BindableType to use. If unable to infer an appropriate BindableType, fall back to using setParameterList(String, Collection).

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

<P> CommonQueryContract setParameterList(QueryParameter<P> parameter,
 Collection<? extends P> values,
 BindableType<P> type)

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

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

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

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.

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

<P> CommonQueryContract 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 BindableType to use. If unable to infer an appropriate BindableType, fall back to using setParameterList(String, Collection).

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

<P> CommonQueryContract setParameterList(QueryParameter<P> parameter,
 P[] values,
 BindableType<P> type)

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

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

CommonQueryContract setProperties(Object bean)

Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

CommonQueryContract 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.

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining