Interface MutationOrSelectionQuery

All Superinterfaces:

CommonQueryContract, Query, Query<Object>, StatementOrTypedQuery

@Incubating
public interface MutationOrSelectionQuery
extends StatementOrTypedQuery, Query<Object>

Unifies StatementOrTypedQuery with Query, allowing backward compatibility with older versions of Hibernate and JPA which did not carefully distinguish selection queries from insert, update, and delete mutation statements.

An instance of this interface is returned by SharedSessionContract.createQuery(String) or SharedSessionContract.createNamedQuery(String). But in newly written code, this interface should not be used to directly execute a query or statement. Instead:

• to obtain a SelectionQuery, call ofType(Class), asSelectionQuery(), or asSelectionQuery(Class),
• to specify an entity graph, call withEntityGraph(EntityGraph),
• to specify a result set mapping, call withResultSetMapping(ResultSetMapping), or
• to obtain a MutationQuery, call asStatement() or asMutationQuery().

A typical idiom is the following:

List<Book> matchingBooks =
        session.createQuery("from Book where title like :titlePattern")
                .ofType(Book.class)
                .setParameter("titlePattern", pattern)
                .setMaxResults(pageSize)
                .setCacheStoreMode(CacheStoreMode.BYPASS)
                .getResultList();

Since:

8.0

See Also:

• StatementOrTypedQuery
• SelectionQuery
• MutationQuery
• SharedSessionContract.createQuery(String)
• SharedSessionContract.createNamedQuery(String)

Method Summary

Modifier and Type	Method	Description
MutationOrSelectionQuery	addQueryHint(String hint)	Add a database query hint to the SQL query.
MutationQuery	asMutationQuery()	Casts this query as a mutation query.
SelectionQuery<?>	asSelectionQuery()	Casts this query as a SelectionQuery.
<X> SelectionQuery<X>	asSelectionQuery(EntityGraph<X> entityGraph)	Casts this query as a SelectionQuery with the given result graph.
<X> SelectionQuery<X>	asSelectionQuery(EntityGraph<X> entityGraph, GraphSemantic graphSemantic)	Overload of asSelectionQuery(EntityGraph) allowing a specific semantic (load/fetch) for the graph.
<R> SelectionQuery<R>	asSelectionQuery(Class<R> type)	Casts this query as a SelectionQuery with the given result type.
MutationQuery	asStatement()
MutationOrSelectionQuery	disableFetchProfile(String profileName)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	enableFetchProfile(String profileName)	Deprecated, for removal: This API element is subject to removal in a future version.
int	executeUpdate()	Deprecated, for removal: This API element is subject to removal in a future version.
List	getResultList()	Deprecated, for removal: This API element is subject to removal in a future version.
Stream	getResultStream()	Deprecated, for removal: This API element is subject to removal in a future version.
Object	getSingleResult()	Deprecated, for removal: This API element is subject to removal in a future version.
Object	getSingleResultOrNull()	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isMutationQuery()
boolean	isSelectionQuery()
List	list()	Deprecated, for removal: This API element is subject to removal in a future version.
<R> SelectionQuery<R>	ofType(Class<R> resultType)
ScrollableResults	scroll()	Deprecated, for removal: This API element is subject to removal in a future version.
ScrollableResults	scroll(ScrollMode scrollMode)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setCacheable(boolean cacheable)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setCacheMode(CacheMode cacheMode)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setCacheRegion(String cacheRegion)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setCacheStoreMode(CacheStoreMode cacheStoreMode)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setComment(String comment)	Set the comment for this query.
<P> MutationOrSelectionQuery	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> MutationOrSelectionQuery	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
MutationOrSelectionQuery	setEntityGraph(EntityGraph<? super Object> graph, GraphSemantic semantic)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setFetchSize(int fetchSize)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setFirstResult(int startPosition)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setFlushMode(FlushModeType flushMode)	Deprecated.
MutationOrSelectionQuery	setFollowOnStrategy(Locking.FollowOn followOnStrategy)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setHibernateLockMode(LockMode lockMode)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setHint(String hintName, Object value)	Set a hint.
MutationOrSelectionQuery	setLockMode(LockModeType lockMode)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setMaxResults(int maxResults)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
MutationOrSelectionQuery	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
MutationOrSelectionQuery	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
MutationOrSelectionQuery	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> MutationOrSelectionQuery	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> MutationOrSelectionQuery	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.
MutationOrSelectionQuery	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
MutationOrSelectionQuery	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> MutationOrSelectionQuery	setParameter(Parameter<P> param, P value)
MutationOrSelectionQuery	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
MutationOrSelectionQuery	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
MutationOrSelectionQuery	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
MutationOrSelectionQuery	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> MutationOrSelectionQuery	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	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.
MutationOrSelectionQuery	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
MutationOrSelectionQuery	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> MutationOrSelectionQuery	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> MutationOrSelectionQuery	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.
MutationOrSelectionQuery	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
MutationOrSelectionQuery	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> MutationOrSelectionQuery	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	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> MutationOrSelectionQuery	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> MutationOrSelectionQuery	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> MutationOrSelectionQuery	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.
MutationOrSelectionQuery	setParameters(Object... arguments)
MutationOrSelectionQuery	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.
MutationOrSelectionQuery	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.
MutationOrSelectionQuery	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
MutationOrSelectionQuery	setQueryPlanCacheable(boolean queryPlanCacheable)	Deprecated.
MutationOrSelectionQuery	setReadOnly(boolean readOnly)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setResultListTransformer(ResultListTransformer<Object> transformer)	Deprecated, for removal: This API element is subject to removal in a future version.
MutationOrSelectionQuery	setTimeout(int timeout)	Specify a JDBC query timeout to use when executing the query.
MutationOrSelectionQuery	setTimeout(Timeout timeout)	Specify a JDBC query timeout to use when executing the query.
MutationOrSelectionQuery	setTimeout(Integer timeout)	Specify a JDBC query timeout to use when executing the query.
<X> Query<X>	setTupleTransformer(TupleTransformer<X> transformer)	Deprecated, for removal: This API element is subject to removal in a future version.
Stream	stream()	Deprecated, for removal: This API element is subject to removal in a future version.
Object	uniqueResult()	Deprecated, for removal: This API element is subject to removal in a future version.
Optional	uniqueResultOptional()	Deprecated, for removal: This API element is subject to removal in a future version.
<R> SelectionQuery<R>	withEntityGraph(EntityGraph<R> graph)
<R> SelectionQuery<R>	withResultSetMapping(jakarta.persistence.sql.ResultSetMapping<R> mapping)

Methods inherited from interface CommonQueryContract

getComment, getEffectiveFlushMode, getParameterMetadata, getQueryFlushMode, getSession, getTimeout

Methods inherited from interface Query

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

Methods inherited from interface Query

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getFlushMode, getHibernateLockMode, getLockMode, getMaxResults, getQueryOptions, getQueryString, isCacheable, isQueryPlanCacheable, isReadOnly

Method Details

isSelectionQuery

boolean isSelectionQuery()

isMutationQuery

boolean isMutationQuery()

asSelectionQuery

@Nonnull
SelectionQuery<?> asSelectionQuery()

Casts this query as a SelectionQuery.

Throws:

IllegalSelectQueryException - If the query is not a select query.

asSelectionQuery

@Nonnull
<R> SelectionQuery<R> asSelectionQuery(Class<R> type)

Casts this query as a SelectionQuery with the given result type.

Throws:

IllegalSelectQueryException - If the query is not a select query.

IllegalArgumentException - If the given type is not compatible with the query's defined result type.

asSelectionQuery

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

Casts this query as a SelectionQuery with the given result graph.

Throws:

IllegalSelectQueryException - If the query is not a selection query.

IllegalArgumentException - If the given graph result type is not compatible with the Query type parameter.

asSelectionQuery

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

Overload of asSelectionQuery(EntityGraph) allowing a specific semantic (load/fetch) for the graph.

Parameters:

entityGraph - The entity graph.

graphSemantic - The load/fetch semantic.

Returns:

The cast/converted query.

See Also:

• SharedSessionContract.createSelectionQuery(String, EntityGraph)
• SharedSessionContract.createQuery(String, EntityGraph)
• asSelectionQuery(Class)

asMutationQuery

@Nonnull
MutationQuery asMutationQuery()

Casts this query as a mutation query.

Throws:

IllegalMutationQueryException - If the query is not a mutation query.

ofType

@Nonnull
<R> SelectionQuery<R> ofType(@Nonnull
 Class<R> resultType)

Specified by:

ofType in interface StatementOrTypedQuery

Parameters:

resultType - The Java class of the query result type

withEntityGraph

@Nonnull
<R> SelectionQuery<R> withEntityGraph(@Nonnull
 EntityGraph<R> graph)

Specified by:

withEntityGraph in interface StatementOrTypedQuery

Parameters:

graph - The entity graph, interpreted as a load graph

withResultSetMapping

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

Specified by:

withResultSetMapping in interface StatementOrTypedQuery

Parameters:

mapping - The result set mapping

asStatement

@Nonnull
MutationQuery asStatement()

Specified by:

asStatement in interface StatementOrTypedQuery

setQueryFlushMode

@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setQueryFlushMode in interface Query<Object>

Specified by:

setQueryFlushMode in interface StatementOrTypedQuery

See Also:

• Session.getHibernateFlushMode()

setQueryPlanCacheable

@Deprecated
@Nonnull
MutationOrSelectionQuery setQueryPlanCacheable(boolean queryPlanCacheable)

Deprecated.

Description copied from interface: Query

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

Specified by:

setQueryPlanCacheable in interface Query<Object>

See Also:

• Query.isQueryPlanCacheable()

addQueryHint

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

setTimeout

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

See Also:

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

setTimeout

@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setTimeout in interface Query<Object>

Specified by:

setTimeout in interface StatementOrTypedQuery

See Also:

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

setTimeout

@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setTimeout in interface Query<Object>

Specified by:

setTimeout in interface StatementOrTypedQuery

setComment

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

See Also:

• CommonQueryContract.getComment()

setHint

@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setHint in interface Query<Object>

Specified by:

setHint in interface StatementOrTypedQuery

See Also:

• HibernateHints
• SpecHints

setFlushMode

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setFlushMode in interface Query<Object>

See Also:

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

setEntityGraph

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setEntityGraph(@Nonnull
 EntityGraph<? super Object> graph,
 @Nonnull
 GraphSemantic semantic)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Apply an EntityGraph to the query.

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Specified by:

setEntityGraph in interface Query<Object>

See Also:

• SharedSessionContract.createSelectionQuery(String, EntityGraph)
• asSelectionQuery(EntityGraph)
• asSelectionQuery(EntityGraph, GraphSemantic)
• StatementOrTypedQuery.withEntityGraph(EntityGraph)

executeUpdate

@Deprecated(forRemoval=true)
int executeUpdate()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute an insert, update, or delete statement, and return the number of affected entities.

For use with instances of MutationQuery created using SharedSessionContract.createMutationQuery(String), SharedSessionContract.createNamedMutationQuery(String), SharedSessionContract.createNativeMutationQuery(String), or SharedSessionContract.createMutationQuery(jakarta.persistence.criteria.CriteriaStatement).

Specified by:

executeUpdate in interface Query

Specified by:

executeUpdate in interface Query<Object>

Returns:

the number of affected entity instances (may differ from the number of affected rows)

See Also:

• Query.executeUpdate()

getResultList

@Deprecated(forRemoval=true)
@Nonnull
List getResultList()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the Query<T> results as a List. If the Query<T> contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

getResultList in interface Query

Specified by:

getResultList in interface Query<Object>

Returns:

the results as a list

getSingleResult

@Deprecated(forRemoval=true)
Object getSingleResult()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the single result of the query, throwing an exception if the Query<T> returns no results.

Specified by:

getSingleResult in interface Query

Specified by:

getSingleResult in interface Query<Object>

Returns:

the single result, only if there is exactly one

getSingleResultOrNull

@Deprecated(forRemoval=true)
@Nullable
Object getSingleResultOrNull()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the single result of the query or null if the Query<T> returns no results, throwing and exception if the Query<T> returns more than one result.

Specified by:

getSingleResultOrNull in interface Query

Specified by:

getSingleResultOrNull in interface Query<Object>

Returns:

the single result, if there is exactly one result, or null if there are no results to return

getResultStream

@Deprecated(forRemoval=true)
@Nonnull
Stream getResultStream()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the Query<T> results as a Stream. If the Query<T> contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

getResultStream in interface Query

Specified by:

getResultStream in interface Query<Object>

Returns:

The results as a Stream

list

@Deprecated(forRemoval=true)
@Nonnull
List list()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the Query<T> results as a List. If the Query<T> contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

list in interface Query<Object>

Returns:

the result list

scroll

@Deprecated(forRemoval=true)
@Nonnull
ScrollableResults scroll()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the results in a scrollable form.

This overload simply calls Query.scroll(ScrollMode) using the default scroll mode of the SQL dialect.

Specified by:

scroll in interface Query<Object>

scroll

@Deprecated(forRemoval=true)
@Nonnull
ScrollableResults scroll(@Nonnull
 ScrollMode scrollMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the results in a scrollable form. The capabilities of the returned ScrollableResults depend on the specified ScrollMode.

Specified by:

scroll in interface Query<Object>

stream

@Deprecated(forRemoval=true)
@Nonnull
Stream stream()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the Query<T> results as a Stream. If the Query<T> contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

stream in interface Query<Object>

Returns:

The results as a Stream

uniqueResult

@Deprecated(forRemoval=true)
@Nullable
Object uniqueResult()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the single result of the query, or null if the Query<T> returns no results.

Specified by:

uniqueResult in interface Query<Object>

Returns:

the single result or null if there is no result to return

uniqueResultOptional

@Deprecated(forRemoval=true)
@Nonnull
Optional uniqueResultOptional()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Execute the Query<T> and return the single result of the Query<T> as an instance of Optional.

Specified by:

uniqueResultOptional in interface Query<Object>

Returns:

the single result as an Optional

setFetchSize

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setFetchSize(int fetchSize)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Specify a JDBC fetch size to use when executing this query.

Specified by:

setFetchSize in interface Query<Object>

Parameters:

fetchSize - the fetch size hint

Returns:

this, for method chaining

See Also:

• Query.getFetchSize()
• JdbcSettings.STATEMENT_FETCH_SIZE

setReadOnly

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setReadOnly(boolean readOnly)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

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 Query<Object>

Parameters:

readOnly - true indicates that entities and proxies loaded by the query are to be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode

Returns:

this, for method chaining

setMaxResults

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setMaxResults(int maxResults)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<Object>

setFirstResult

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setFirstResult(int startPosition)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<Object>

setCacheMode

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setCacheMode(@Nonnull
 CacheMode cacheMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

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 Query<Object>

See Also:

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

setCacheStoreMode

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setCacheStoreMode(@Nonnull
 CacheStoreMode cacheStoreMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<Object>

setCacheRetrieveMode

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setCacheRetrieveMode(@Nonnull
 CacheRetrieveMode cacheRetrieveMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<Object>

setCacheRegion

@Deprecated(forRemoval=true)
MutationOrSelectionQuery setCacheRegion(@Nullable
 String cacheRegion)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Set the name of the cache region where query results should be cached (assuming Query.isCacheable()). null indicates to use the default region.

Specified by:

setCacheRegion in interface Query<Object>

See Also:

• Query.getCacheRegion()

setLockMode

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setLockMode(@Nonnull
 LockModeType lockMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<Object>

setHibernateLockMode

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setHibernateLockMode(@Nonnull
 LockMode lockMode)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

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

Specified by:

setHibernateLockMode in interface Query<Object>

See Also:

• Query.setLockMode(LockModeType)

setFollowOnStrategy

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setFollowOnStrategy(@Nonnull
 Locking.FollowOn followOnStrategy)

Deprecated, for removal: This API element is subject to removal in a future version.

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

Parameters:

followOnStrategy - The strategy for follow-on locking.

Returns:

this, for method chaining

setCacheable

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setCacheable(boolean cacheable)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Enable/disable second level query (result) caching for this query.

Specified by:

setCacheable in interface Query<Object>

See Also:

• Query.isCacheable()

enableFetchProfile

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery enableFetchProfile(@Nonnull
 String profileName)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Enable the fetch profile with the given name during execution of this query. If the requested fetch profile is already enabled, the call has no effect.

This is an alternative way to specify the associations which should be fetched as part of the initial query.

Specified by:

enableFetchProfile in interface Query<Object>

Parameters:

profileName - the name of the fetch profile to be enabled

See Also:

• FetchProfile

disableFetchProfile

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery disableFetchProfile(@Nonnull
 String profileName)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Disable the fetch profile with the given name in this session. If the fetch profile is not currently enabled, the call has no effect.

Specified by:

disableFetchProfile in interface Query<Object>

Parameters:

profileName - the name of the fetch profile to be disabled

See Also:

• FetchProfile

setResultListTransformer

@Deprecated(forRemoval=true)
@Nonnull
MutationOrSelectionQuery setResultListTransformer(@Nonnull
 ResultListTransformer<Object> transformer)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Set a ResultListTransformer.

Specified by:

setResultListTransformer in interface Query<Object>

setTupleTransformer

@Deprecated(forRemoval=true)
@Nonnull
<X> Query<X> setTupleTransformer(@Nonnull
 TupleTransformer<X> transformer)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Query

Set a TupleTransformer.

Specified by:

setTupleTransformer in interface Query<Object>

setParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

See Also:

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

setParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

setParameter

@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

See Also:

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

setParameter

@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

See Also:

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

setParameters

@Nonnull
MutationOrSelectionQuery setParameters(@Nonnull
 Object... arguments)

Description copied from interface: Query

Specified by:

setParameters in interface CommonQueryContract

Specified by:

setParameters in interface Query

Specified by:

setParameters in interface Query<Object>

Specified by:

setParameters in interface StatementOrTypedQuery

See Also:

• Query.setParameters(Object...)

setParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

setConvertedParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query

Specified by:

setConvertedParameter in interface Query<Object>

Specified by:

setConvertedParameter in interface StatementOrTypedQuery

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query

Specified by:

setConvertedParameter in interface Query<Object>

Specified by:

setConvertedParameter in interface StatementOrTypedQuery

See Also:

• Query.setConvertedParameter(int, Object, Class)

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query<Object>

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query<Object>

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

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> MutationOrSelectionQuery 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 Query<Object>

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> MutationOrSelectionQuery 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 Query<Object>

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> MutationOrSelectionQuery setParameter(@Nonnull
 Parameter<P> param,
 @Nullable
 P value)

Description copied from interface: Query

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<Object>

Specified by:

setParameter in interface StatementOrTypedQuery

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated
@Nonnull
MutationOrSelectionQuery 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 Query

Specified by:

setParameter in interface Query<Object>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

See Also:

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

setParameterList

@Nonnull
<P> MutationOrSelectionQuery 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 Query<Object>

Returns:

this, for method chaining

setProperties

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

@Nonnull
MutationOrSelectionQuery 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 Query<Object>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining