Interface MutationQuery

All Superinterfaces:

CommonQueryContract, Query, Statement

All Known Subinterfaces:

MutationQueryImplementor<T>, NativeQuery<T>, NativeQueryImplementor<R>

@Incubating
public interface MutationQuery
extends CommonQueryContract, Statement

Within the context of an active session, an instance of this type represents an executable mutation query, that is, an insert, update, or delete. This interface extends the JPA-defined Statement interface, adding additional operations.

A MutationQuery may be obtained from the Session by calling:

• SharedSessionContract.createStatement(String) or SharedSessionContract.createMutationQuery(String), passing the HQL insert, update, or delete statement as a string,
• SharedSessionContract.createNativeStatement(String) or SharedSessionContract.createNativeMutationQuery(String), passing the native SQL statement as a string,
• SharedSessionContract.createStatement(CriteriaStatement) or SharedSessionContract.createMutationQuery(CriteriaStatement), passing a criteria update or delete object, or
• SharedSessionContract.createNamedStatement(String) or SharedSessionContract.createNamedMutationQuery(String), passing the name of a statement declared using NamedQuery or NamedNativeQuery.

A MutationQuery controls how the mutation query is executed, and allows arguments to be bound to its parameters.

• Mutation queries should be executed using execute(), since executeUpdate() is now deprecated.
• The various overloads of setParameter(String, Object) and setParameter(int, Object) allow arguments to be bound to named and ordinal parameters defined by the query.

session.createStatement("delete Draft where lastUpdated < local date - ?1 year")
        .setParameter(1, years)
        .executeUpdate();

Since:

6.0

See Also:

• Statement
• SharedSessionContract.createStatement(String)
• SharedSessionContract.createMutationQuery(String)
• SharedSessionContract.createNativeStatement(String)
• SharedSessionContract.createNativeMutationQuery(String)
• SharedSessionContract.createMutationQuery(CriteriaStatement)
• SharedSessionContract.createStatement(CriteriaStatement)
• SharedSessionContract.createNamedMutationQuery(String)
• SharedSessionContract.createNamedStatement(String)
• MutationOrSelectionQuery.asMutationQuery()

Nested Class Summary

Nested classes/interfaces inherited from interface Statement

Statement.Option

Method Summary

Modifier and Type	Method	Description
MutationQuery	addOption(Statement.Option option)
MutationQuery	addQueryHint(String hint)	Add a database query hint to the SQL query.
int	execute()	Execute an insert, update, or delete statement and return the number of affected entities.
int	executeUpdate()	Deprecated. Use execute() instead.
String	getMutationString()	The HQL or native-SQL string, or null in the case of a criteria query.
Class<?>	getTargetType()	The Java type of the thing being mutated, if known.
MutationQuery	setComment(String comment)	Set the comment for this query.
<P> MutationQuery	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> MutationQuery	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
MutationQuery	setFlushMode(FlushModeType flushMode)	Deprecated.
MutationQuery	setHint(String hintName, Object value)	Set a hint.
MutationQuery	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
MutationQuery	setParameter(int position, Instant value, TemporalType temporalType)	Deprecated.
MutationQuery	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
MutationQuery	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> MutationQuery	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> MutationQuery	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.
MutationQuery	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
MutationQuery	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<P> MutationQuery	setParameter(Parameter<P> param, P value)
MutationQuery	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
MutationQuery	setParameter(String name, Instant value, TemporalType temporalType)	Deprecated.
MutationQuery	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
MutationQuery	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> MutationQuery	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> MutationQuery	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> MutationQuery	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> MutationQuery	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> MutationQuery	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.
MutationQuery	setParameterList(int position, Object[] values)	Bind multiple arguments to an ordinal query parameter.
MutationQuery	setParameterList(int position, Collection values)	Bind multiple arguments to an ordinal query parameter.
<P> MutationQuery	setParameterList(int position, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> MutationQuery	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> MutationQuery	setParameterList(int position, P[] values, Type<P> type)	Bind multiple arguments to an ordinal query parameter using the given Type.
<P> MutationQuery	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.
MutationQuery	setParameterList(String name, Object[] values)	Bind multiple arguments to a named query parameter.
MutationQuery	setParameterList(String name, Collection values)	Bind multiple arguments to a named query parameter.
<P> MutationQuery	setParameterList(String name, Collection<? extends P> values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> MutationQuery	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> MutationQuery	setParameterList(String name, P[] values, Type<P> type)	Bind multiple arguments to a named query parameter using the given Type.
<P> MutationQuery	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> MutationQuery	setParameterList(QueryParameter<P> parameter, Collection<? extends P> values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> MutationQuery	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> MutationQuery	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> MutationQuery	setParameterList(QueryParameter<P> parameter, P[] values)	Bind multiple arguments to the query parameter represented by the given QueryParameter.
<P> MutationQuery	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> MutationQuery	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.
MutationQuery	setParameters(Object... arguments)
MutationQuery	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.
MutationQuery	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.
MutationQuery	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
MutationQuery	setTimeout(int timeout)	Specify a JDBC query timeout to use when executing the query.
MutationQuery	setTimeout(Timeout timeout)	Specify a JDBC query timeout to use when executing the query.
MutationQuery	setTimeout(Integer timeout)	Specify a JDBC query timeout to use when executing the query.

Methods inherited from interface CommonQueryContract

getComment, getEffectiveFlushMode, getParameterMetadata, getQueryFlushMode, getSession, getTimeout

Methods inherited from interface Query

getCacheRetrieveMode, getCacheStoreMode, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getResultList, getResultStream, getSingleResult, getSingleResultOrNull, isBound, setCacheRetrieveMode, setCacheStoreMode, setFirstResult, setLockMode, setMaxResults, unwrap

Methods inherited from interface Statement

getOptions

Method Details

getMutationString

@Nullable
String getMutationString()

The HQL or native-SQL string, or null in the case of a criteria query.

getTargetType

@Nullable
Class<?> getTargetType()

The Java type of the thing being mutated, if known.

execute

int execute()

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

Specified by:

execute in interface Statement

Returns:

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

executeUpdate

@Deprecated(since="8")
int executeUpdate()

Deprecated.

Use execute() instead.

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

Specified by:

executeUpdate in interface Query

Returns:

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

setQueryFlushMode

@Nonnull
MutationQuery setQueryFlushMode(@Nonnull
 QueryFlushMode queryFlushMode)

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 Statement

See Also:

• Session.getHibernateFlushMode()

setFlushMode

@Deprecated(since="7")
@Nonnull
MutationQuery setFlushMode(@Nonnull
 FlushModeType flushMode)

Deprecated.

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Statement

setTimeout

@Nonnull
MutationQuery setTimeout(int timeout)

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

Specified by:

setTimeout in interface CommonQueryContract

See Also:

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

setTimeout

@Nonnull
MutationQuery setTimeout(@Nullable
 Integer timeout)

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 Statement

See Also:

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

setTimeout

@Nonnull
MutationQuery setTimeout(@Nullable
 Timeout timeout)

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 Statement

setComment

@Nonnull
MutationQuery setComment(@Nullable
 String comment)

Set the comment for this query.

If SQL commenting is enabled, the comment will be added to the SQL query sent to the database, which may be useful for identifying the source of troublesome queries.

SQL commenting may be enabled using the configuration property "hibernate.use_sql_comments".

Specified by:

setComment in interface CommonQueryContract

See Also:

• CommonQueryContract.getComment()

setHint

@Nonnull
MutationQuery setHint(@Nonnull
 String hintName,
 @Nullable
 Object value)

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 Statement

See Also:

• HibernateHints
• SpecHints

addOption

@Nonnull
MutationQuery addOption(@Nonnull
 Statement.Option option)

Specified by:

addOption in interface Statement

addQueryHint

@Nonnull
MutationQuery addQueryHint(@Nonnull
 String hint)

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

setConvertedParameter

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

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Statement

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

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

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Statement

See Also:

• Query.setConvertedParameter(int, Object, Class)

setParameter

@Nonnull
MutationQuery setParameter(@Nonnull
 String name,
 @Nullable
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

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

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

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

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

setParameter

@Deprecated(since="7")
@Nonnull
MutationQuery setParameter(@Nonnull
 String name,
 @Nullable
 Instant value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
@Nonnull
MutationQuery setParameter(@Nonnull
 String name,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
MutationQuery setParameter(@Nonnull
 String name,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Nonnull
MutationQuery setParameter(int position,
 @Nullable
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

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

setParameters

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

Specified by:

setParameters in interface CommonQueryContract

Specified by:

setParameters in interface Query

Specified by:

setParameters in interface Statement

See Also:

• Query.setParameters(Object...)

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

setParameter

@Deprecated(since="7")
@Nonnull
MutationQuery setParameter(int position,
 @Nullable
 Instant value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

setParameter

@Deprecated(since="7")
@Nonnull
MutationQuery setParameter(int position,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(int, Date, TemporalType)

setParameter

@Deprecated(since="7")
@Nonnull
MutationQuery setParameter(int position,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

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

Description copied from interface: CommonQueryContract

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

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

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> MutationQuery setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P value,
 @Nonnull
 Class<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

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> MutationQuery setParameter(@Nonnull
 QueryParameter<P> parameter,
 @Nullable
 P val,
 @Nonnull
 Type<P> type)

Description copied from interface: CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

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

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

Deprecated.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Statement

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameterList

@Nonnull
MutationQuery setParameterList(@Nonnull
 String name,
 @Nonnull
 Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
MutationQuery setParameterList(@Nonnull
 String name,
 @Nonnull
 Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to a named query parameter.

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
MutationQuery setParameterList(int position,
 @Nonnull
 Collection values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameterList(int, Collection, Type)

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

@Nonnull
MutationQuery setParameterList(int position,
 @Nonnull
 Object[] values)

Description copied from interface: CommonQueryContract

Bind multiple arguments to an ordinal query parameter.

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

The type of the parameter is inferred from the context in which it occurs, and from the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

The type of the parameter is inferred between the context in which it occurs, the type associated with the QueryParameter and the type of the first given argument.

Specified by:

setParameterList in interface CommonQueryContract

Parameters:

parameter - the parameter memento

values - a collection of arguments

Returns:

this, for method chaining

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

See Also:

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

setParameterList

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

Description copied from interface: CommonQueryContract

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

Specified by:

setParameterList in interface CommonQueryContract

Returns:

this, for method chaining

setProperties

@Nonnull
MutationQuery setProperties(@Nonnull
 Object bean)

Description copied from interface: CommonQueryContract

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

Specified by:

setProperties in interface CommonQueryContract

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

@Nonnull
MutationQuery setProperties(@Nonnull
 Map bean)

Description copied from interface: CommonQueryContract

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

Specified by:

setProperties in interface CommonQueryContract

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining