Interface QueryImplementor<T>

All Superinterfaces:

CommonQueryContract, CommonQueryContractImplementor, Query, Query<T>

All Known Subinterfaces:

MutationQueryImplementor<T>, NativeQueryImplementor<R>, ProcedureCallImplementor<R>, SelectionQueryImplementor<R>

@Incubating
public interface QueryImplementor<T>
extends Query<T>, CommonQueryContractImplementor

Method Summary

Modifier and Type	Method	Description
QueryImplementor<T>	addQueryHint(String hint)	Add a database query hint to the SQL query.
MutationQueryImplementor<T>	asMutationQuery()
SelectionQueryImplementor<T>	asSelectionQuery()
<X> SelectionQueryImplementor<X>	asSelectionQuery(EntityGraph<X> entityGraph)
<X> SelectionQueryImplementor<X>	asSelectionQuery(EntityGraph<X> entityGraph, GraphSemantic graphSemantic)
<X> SelectionQueryImplementor<X>	asSelectionQuery(Class<X> type)
QueryParameterBindings	getParameterBindings()
QueryImplementor<T>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
QueryImplementor<T>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
QueryImplementor<T>	setComment(String comment)	Set the comment for this query.
<P> QueryImplementor<T>	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> QueryImplementor<T>	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
QueryImplementor<T>	setFirstResult(int startPosition)
QueryImplementor<T>	setFlushMode(FlushModeType flushMode)	Deprecated.
QueryImplementor<T>	setFollowOnStrategy(Locking.FollowOn strategy)	Control how Hibernate should handle cases where it is determined subsequent SQL queries would be needs to completely accomplish locking as requested.
QueryImplementor<T>	setHibernateLockMode(LockMode lockMode)	Specify the root LockMode for the query using Hibernate's native LockMode.
QueryImplementor<T>	setHint(String hintName, Object value)	Set a hint.
QueryImplementor<T>	setLockMode(LockModeType lockMode)
QueryImplementor<T>	setMaxResults(int maxResults)
QueryImplementor<T>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
QueryImplementor<T>	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
QueryImplementor<T>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
QueryImplementor<T>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> QueryImplementor<T>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> QueryImplementor<T>	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.
QueryImplementor<T>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
QueryImplementor<T>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> QueryImplementor<T>	setParameter(Parameter<P> param, P value)
QueryImplementor<T>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
QueryImplementor<T>	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
QueryImplementor<T>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
QueryImplementor<T>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> QueryImplementor<T>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> QueryImplementor<T>	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> QueryImplementor<T>	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> QueryImplementor<T>	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> QueryImplementor<T>	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.
QueryImplementor<T>	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
QueryImplementor<T>	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> QueryImplementor<T>	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> QueryImplementor<T>	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> QueryImplementor<T>	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> QueryImplementor<T>	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.
QueryImplementor<T>	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
QueryImplementor<T>	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> QueryImplementor<T>	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> QueryImplementor<T>	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> QueryImplementor<T>	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> QueryImplementor<T>	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> QueryImplementor<T>	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> QueryImplementor<T>	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> QueryImplementor<T>	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> QueryImplementor<T>	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> QueryImplementor<T>	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> QueryImplementor<T>	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.
QueryImplementor<T>	setParameters(Object... arguments)
QueryImplementor<T>	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.
QueryImplementor<T>	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.
QueryImplementor<T>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
QueryImplementor<T>	setQueryPlanCacheable(boolean queryPlanCacheable)	Enable or disable query plan caching for this query, if available.
QueryImplementor<T>	setTimeout(int timeout)	Specify a JDBC query timeout to use when executing the query.
QueryImplementor<T>	setTimeout(Timeout timeout)	Specify a JDBC query timeout to use when executing the query.
QueryImplementor<T>	setTimeout(Integer timeout)	Specify a JDBC query timeout to use when executing the query.
<R> SelectionQueryImplementor<R>	withResultSetMapping(jakarta.persistence.sql.ResultSetMapping<R> mapping)

Methods inherited from interface CommonQueryContract

getComment, getEffectiveFlushMode, getParameterMetadata, getQueryFlushMode, getTimeout

Methods inherited from interface CommonQueryContractImplementor

getSession

Methods inherited from interface Query

getHints, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Methods inherited from interface Query

disableFetchProfile, enableFetchProfile, executeUpdate, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getFlushMode, getHibernateLockMode, getLockMode, getMaxResults, getQueryOptions, getQueryString, getResultList, getResultStream, getSingleResult, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, list, scroll, scroll, setCacheable, setCacheMode, setCacheRegion, setEntityGraph, setFetchSize, setReadOnly, setResultListTransformer, setTupleTransformer, stream, uniqueResult, uniqueResultOptional

Method Details

asMutationQuery

@Nonnull
MutationQueryImplementor<T> asMutationQuery()

asSelectionQuery

@Nonnull
SelectionQueryImplementor<T> asSelectionQuery()

asSelectionQuery

@Nonnull
<X> SelectionQueryImplementor<X> asSelectionQuery(Class<X> type)

asSelectionQuery

@Nonnull
<X> SelectionQueryImplementor<X> asSelectionQuery(EntityGraph<X> entityGraph)

asSelectionQuery

@Nonnull
<X> SelectionQueryImplementor<X> asSelectionQuery(EntityGraph<X> entityGraph,
 GraphSemantic graphSemantic)

withResultSetMapping

@Nonnull
<R> SelectionQueryImplementor<R> withResultSetMapping(jakarta.persistence.sql.ResultSetMapping<R> mapping)

setQueryFlushMode

@Nonnull
QueryImplementor<T> setQueryFlushMode(@Nonnull
 QueryFlushMode queryFlushMode)

Description copied from interface: Query

Set the QueryFlushMode to use for this query.

A QueryFlushMode only affects stateful sessions. A stateless session has no persistence context to flush.

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface CommonQueryContractImplementor

Specified by:

setQueryFlushMode in interface Query

Specified by:

setQueryFlushMode in interface Query<T>

See Also:

• Session.getHibernateFlushMode()

setFlushMode

@Deprecated
@Nonnull
QueryImplementor<T> setFlushMode(@Nonnull
 FlushModeType flushMode)

Deprecated.

Description copied from interface: Query

Set the FlushModeType to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use Query.setQueryFlushMode(QueryFlushMode) passing QueryFlushMode.NO_FLUSH instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface CommonQueryContractImplementor

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<T>

See Also:

• CommonQueryContract.getQueryFlushMode()
• Query.setQueryFlushMode(QueryFlushMode)
• Session.getHibernateFlushMode()

setComment

@Nonnull
QueryImplementor<T> setComment(@Nullable
 String comment)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setComment in interface Query<T>

See Also:

• CommonQueryContract.getComment()

addQueryHint

@Nonnull
QueryImplementor<T> addQueryHint(@Nonnull
 String hint)

Description copied from interface: Query

Add a database query hint to the SQL query.

Multiple query hints may be specified. The operation Dialect.getQueryHintString(String, List) determines how the hint is actually added to the SQL query.

Specified by:

addQueryHint in interface CommonQueryContract

Specified by:

addQueryHint in interface CommonQueryContractImplementor

Specified by:

addQueryHint in interface Query<T>

setTimeout

@Nonnull
QueryImplementor<T> setTimeout(int timeout)

Description copied from interface: Query

Specify a JDBC query timeout to use when executing the query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface Query<T>

See Also:

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

setTimeout

@Nonnull
QueryImplementor<T> setTimeout(@Nullable
 Integer timeout)

Description copied from interface: Query

Specify a JDBC query timeout to use when executing the query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<T>

See Also:

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

setTimeout

@Nonnull
QueryImplementor<T> setTimeout(@Nullable
 Timeout timeout)

Description copied from interface: Query

Specify a JDBC query timeout to use when executing the query.

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<T>

setQueryPlanCacheable

@Nonnull
QueryImplementor<T> setQueryPlanCacheable(boolean queryPlanCacheable)

Description copied from interface: Query

Enable or disable query plan caching for this query, if available.

Specified by:

setQueryPlanCacheable in interface Query<T>

See Also:

• Query.isQueryPlanCacheable()

setCacheStoreMode

@Nonnull
QueryImplementor<T> setCacheStoreMode(@Nonnull
 CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface CommonQueryContractImplementor

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<T>

setCacheRetrieveMode

@Nonnull
QueryImplementor<T> setCacheRetrieveMode(@Nonnull
 CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface CommonQueryContractImplementor

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<T>

setMaxResults

@Nonnull
QueryImplementor<T> setMaxResults(int maxResults)

Specified by:

setMaxResults in interface CommonQueryContractImplementor

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<T>

setFirstResult

@Nonnull
QueryImplementor<T> setFirstResult(int startPosition)

Specified by:

setFirstResult in interface CommonQueryContractImplementor

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<T>

setLockMode

@Nonnull
QueryImplementor<T> setLockMode(@Nonnull
 LockModeType lockMode)

Specified by:

setLockMode in interface CommonQueryContractImplementor

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<T>

setHibernateLockMode

@Nonnull
QueryImplementor<T> setHibernateLockMode(@Nonnull
 LockMode lockMode)

Description copied from interface: Query

Specify the root LockMode for the query using Hibernate's native LockMode.

Specified by:

setHibernateLockMode in interface Query<T>

See Also:

• Query.setLockMode(LockModeType)

setFollowOnStrategy

@Nonnull
QueryImplementor<T> setFollowOnStrategy(@Nonnull
 Locking.FollowOn strategy)

Description copied from interface: Query

Control how Hibernate should handle cases where it is determined subsequent SQL queries would be needs to completely accomplish locking as requested.

Specified by:

setFollowOnStrategy in interface Query<T>

Parameters:

strategy - The strategy for follow-on locking.

Returns:

this, for method chaining

setHint

@Nonnull
QueryImplementor<T> setHint(@Nonnull
 String hintName,
 @Nullable
 Object value)

Description copied from interface: Query

Set a hint. Hints are a JPA-standard way to control provider-specific behavior affecting execution of the query. Clients of this native Hibernate API should make use of type safe operations of this interface and of its subtypes. For example, SelectionQuery.setCacheRegion(String) is preferred over HibernateHints.HINT_CACHE_REGION.

Since JPA 4, TypedQuery.Option and Statement.Option compete with query hints, offering a more type safe way to accommodate vendor extensions.

The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface CommonQueryContractImplementor

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<T>

See Also:

• HibernateHints
• SpecHints

getParameterBindings

@Nonnull
QueryParameterBindings getParameterBindings()

Specified by:

getParameterBindings in interface CommonQueryContractImplementor

setParameter

@Nonnull
QueryImplementor<T> setParameter(@Nonnull
 String name,
 @Nullable
 Object value)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

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

setParameter

@Nonnull
<P> QueryImplementor<T> setParameter(@Nonnull
 String name,
 @Nullable
 P value,
 @Nonnull
 Class<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

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

setParameter

@Nonnull
<P> QueryImplementor<T> setParameter(@Nonnull
 String name,
 @Nullable
 P value,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

setParameter

@Nonnull
QueryImplementor<T> setParameter(int position,
 @Nullable
 Object value)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

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

setParameters

@Nonnull
QueryImplementor<T> setParameters(@Nonnull
 Object... arguments)

Description copied from interface: Query

Specified by:

setParameters in interface CommonQueryContract

Specified by:

setParameters in interface CommonQueryContractImplementor

Specified by:

setParameters in interface Query

Specified by:

setParameters in interface Query<T>

See Also:

• Query.setParameters(Object...)

setParameter

@Nonnull
<P> QueryImplementor<T> setParameter(int position,
 @Nullable
 P value,
 @Nonnull
 Class<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

@Nonnull
<P> QueryImplementor<T> setParameter(int position,
 @Nullable
 P value,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

setParameter

@Nonnull
<P> QueryImplementor<T> setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P value)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query<T>

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

@Nonnull
<P> QueryImplementor<T> setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P value,
 @Nonnull
 Class<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query<T>

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

@Nonnull
<P> QueryImplementor<T> setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P val,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameter in interface Query<T>

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

@Nonnull
<P> QueryImplementor<T> setParameter(@Nonnull
 Parameter<P> param,
 @Nullable
 P value)

Description copied from interface: Query

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(Parameter, Object)

setProperties

@Nonnull
QueryImplementor<T> setProperties(@Nonnull
 Object bean)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setProperties in interface Query<T>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

@Nonnull
QueryImplementor<T> setProperties(@Nonnull
 Map bean)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setProperties in interface Query<T>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setConvertedParameter

@Nonnull
<P> QueryImplementor<T> setConvertedParameter(@Nonnull
 String name,
 @Nullable
 P value,
 @Nonnull
 Class<? extends AttributeConverter<P,?>> converter)

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface CommonQueryContractImplementor

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<T>

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

@Nonnull
<P> QueryImplementor<T> setConvertedParameter(int position,
 @Nullable
 P value,
 @Nonnull
 Class<? extends AttributeConverter<P,?>> converter)

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface CommonQueryContractImplementor

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<T>

See Also:

• Query.setConvertedParameter(int, Object, Class)

setParameterList

@Nonnull
QueryImplementor<T> setParameterList(@Nonnull
 String name,
 @Nonnull
 Collection values)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 String name,
 @Nonnull
 Collection<? extends P> values,
 @Nonnull
 Class<P> javaType)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 String name,
 @Nonnull
 Collection<? extends P> values,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
QueryImplementor<T> setParameterList(@Nonnull
 String name,
 @Nonnull
 Object[] values)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 String name,
 @Nonnull
 P[] values,
 @Nonnull
 Class<P> javaType)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 String name,
 @Nonnull
 P[] values,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
QueryImplementor<T> setParameterList(int position,
 @Nonnull
 Collection values)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(int position,
 @Nonnull
 Collection<? extends P> values,
 @Nonnull
 Class<P> javaType)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(int position,
 @Nonnull
 Collection<? extends P> values,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
QueryImplementor<T> setParameterList(int position,
 @Nonnull
 Object[] values)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(int position,
 @Nonnull
 P[] values,
 @Nonnull
 Class<P> javaType)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(int position,
 @Nonnull
 P[] values,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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

Specified by:

setParameterList in interface CommonQueryContract

Specified by:

setParameterList in interface CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 Collection<? extends P> values)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 Collection<? extends P> values,
 @Nonnull
 Class<P> javaType)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 Collection<? extends P> values,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 P[] values)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 P[] values,
 @Nonnull
 Class<P> javaType)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> QueryImplementor<T> setParameterList(@Nonnull
 QueryParameter<P> parameter,
 @Nonnull
 P[] values,
 @Nonnull
 Type<P> type)

Description copied from interface: Query

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 CommonQueryContractImplementor

Specified by:

setParameterList in interface Query<T>

Returns:

this, for method chaining

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(int position,
 @Nullable
 Instant value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Bind an Instant value to the ordinal Query<T> parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query<T>

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(int position,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(int position,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(@Nonnull
 String name,
 @Nullable
 Instant value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Bind an Instant value to the named Query<T> parameter using just the portion indicated by the given TemporalType.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query<T>

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(@Nonnull
 String name,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(@Nonnull
 String name,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(@Nonnull
 Parameter<Calendar> param,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
QueryImplementor<T> setParameter(@Nonnull
 Parameter<Date> param,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<T>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)