Interface ProcedureCallImplementor<R>

All Superinterfaces:

AutoCloseable, CommonQueryContract, CommonQueryContractImplementor, NameableQuery, ProcedureCall, Query, Query<R>, QueryImplementor<R>, StoredProcedureQuery, SynchronizeableQuery

public interface ProcedureCallImplementor<R>
extends ProcedureCall, QueryImplementor<R>, NameableQuery

Nested Class Summary

Nested classes/interfaces inherited from interface StoredProcedureQuery

StoredProcedureQuery.Option

Method Summary

Modifier and Type	Method	Description
ProcedureCallImplementor<R>	addQueryHint(String hint)	Add a database query hint to the SQL query.
FunctionReturnImplementor<?>	getFunctionReturn()	The FunctionReturn describing the return value of the function, or null if this ProcedureCall is not a function call.
QueryParameterBindings	getParameterBindings()
ProcedureParameterMetadataImplementor	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
ProcedureParameterImplementor<?>	getParameterRegistration(int position)	Retrieve a previously registered parameter memento by the position under which it was registered.
ProcedureParameterImplementor<?>	getParameterRegistration(String name)	Retrieve a previously registered parameter memento by the name under which it was registered.
ParameterStrategy	getParameterStrategy()
List<R>	getResultList()	Execute the Query<T> and return the Query<T> results as a List.
SharedSessionContractImplementor	getSession()	Get the Session or StatelessSession that was used to create this Query instance.
R	getSingleResult()	Execute the Query<T> and return the single result of the query, throwing an exception if the Query<T> returns no results.
<T> ProcedureParameterImplementor<T>	registerConvertedParameter(int position, Class<? extends AttributeConverter<T,?>> converter, ParameterMode mode)
<T> ProcedureParameterImplementor<T>	registerConvertedParameter(String parameterName, Class<? extends AttributeConverter<T,?>> converter, ParameterMode mode)
<T> ProcedureParameterImplementor<T>	registerParameter(int position, Type<T> type, ParameterMode mode)	Basic form for registering a positional parameter.
<T> ProcedureParameterImplementor<T>	registerParameter(int position, Class<T> type, ParameterMode mode)	Basic form for registering a positional parameter.
<T> ProcedureParameterImplementor<T>	registerParameter(String parameterName, Type<T> type, ParameterMode mode)	Basic form for registering a named parameter.
<T> ProcedureParameterImplementor<T>	registerParameter(String parameterName, Class<T> type, ParameterMode mode)	Basic form for registering a named parameter.
<T> FunctionReturnImplementor<T>	registerResultParameter(Class<T> resultType)
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, Type<?> type, ParameterMode mode)	Like ProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, Class<?> type, ParameterMode mode)
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, Type<?> type, ParameterMode mode)	Like ProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, Class<?> type, ParameterMode mode)
ProcedureCallImplementor<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
ProcedureCallImplementor<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
ProcedureCallImplementor<R>	setComment(String comment)	Set the comment for this query.
<P> ProcedureCallImplementor<R>	setConvertedParameter(int position, P value, Class<? extends AttributeConverter<P,?>> converter)
<P> ProcedureCallImplementor<R>	setConvertedParameter(String name, P value, Class<? extends AttributeConverter<P,?>> converter)
ProcedureCallImplementor<R>	setFirstResult(int startPosition)
ProcedureCallImplementor<R>	setFlushMode(FlushModeType flushMode)	Set the FlushModeType to use for this query.
ProcedureCallImplementor<R>	setHint(String hintName, Object value)	Set a hint.
ProcedureCallImplementor<R>	setLockMode(LockModeType lockMode)
ProcedureCallImplementor<R>	setMaxResults(int maxResults)
ProcedureCallImplementor<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
ProcedureCallImplementor<R>	setParameter(int position, Calendar value, TemporalType temporalType)	Deprecated.
ProcedureCallImplementor<R>	setParameter(int position, Date value, TemporalType temporalType)	Deprecated.
<P> ProcedureCallImplementor<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
<P> ProcedureCallImplementor<R>	setParameter(int position, P value, Class<P> type)	Bind the given argument to an ordinal query parameter using the given Class reference to attempt to infer the Type.
ProcedureCallImplementor<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Deprecated.
ProcedureCallImplementor<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Deprecated.
<T> ProcedureCallImplementor<R>	setParameter(Parameter<T> param, T value)
ProcedureCallImplementor<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
ProcedureCallImplementor<R>	setParameter(String name, Calendar value, TemporalType temporalType)	Deprecated.
ProcedureCallImplementor<R>	setParameter(String name, Date value, TemporalType temporalType)	Deprecated.
<P> ProcedureCallImplementor<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> ProcedureCallImplementor<R>	setParameter(String name, P value, Class<P> type)	Bind the given argument to a named query parameter using the given Class reference to attempt to infer the Type.
ProcedureCallImplementor<R>	setParameters(Object... arguments)
ProcedureCallImplementor<R>	setProperties(Object bean)	Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
ProcedureCallImplementor<R>	setProperties(Map bean)	Bind the values of the given Map to named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
ProcedureCallImplementor<R>	setQueryFlushMode(QueryFlushMode queryFlushMode)	Set the QueryFlushMode to use for this query.
ProcedureCallImplementor<R>	setTimeout(int timeout)	Specify a JDBC query timeout to use when executing the query.
ProcedureCallImplementor<R>	setTimeout(Timeout timeout)	Specify a JDBC query timeout to use when executing the query.
ProcedureCallImplementor<R>	setTimeout(Integer timeout)	Specify a JDBC query timeout to use when executing the query.
NamedCallableQueryMemento	toMemento(String name)	Convert this query into the memento.

Methods inherited from interface CommonQueryContract

getComment, getEffectiveFlushMode, getQueryFlushMode, getTimeout

Methods inherited from interface ProcedureCall

addSynchronizedEntityClass, addSynchronizedEntityName, addSynchronizedQuerySpace, close, getOutputs, getProcedureName, getRegisteredParameters, isFunctionCall, markAsFunctionCall, markAsFunctionCall, markAsFunctionCall

Methods inherited from interface Query

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

Methods inherited from interface Query

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

Methods inherited from interface QueryImplementor

asMutationQuery, asSelectionQuery, asSelectionQuery, asSelectionQuery, asSelectionQuery, setFollowOnStrategy, setHibernateLockMode, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setQueryPlanCacheable, withResultSetMapping

Methods inherited from interface StoredProcedureQuery

addOption, execute, executeUpdate, getOptions, getOutputParameterValue, getOutputParameterValue, getOutputParameterValue, getResultList, getResultList, getSingleResult, getSingleResult, getSingleResultOrNull, getSingleResultOrNull, getSingleResultOrNull, getUpdateCount, hasMoreResults

Methods inherited from interface SynchronizeableQuery

getSynchronizedQuerySpaces

Method Details

getSession

@Nonnull
SharedSessionContractImplementor getSession()

Description copied from interface: CommonQueryContract

Get the Session or StatelessSession that was used to create this Query instance.

Specified by:

getSession in interface CommonQueryContract

Specified by:

getSession in interface CommonQueryContractImplementor

Returns:

The producer of this query

setFlushMode

@Nonnull
ProcedureCallImplementor<R> setFlushMode(@Nonnull
 FlushModeType flushMode)

Description copied from interface: Query

Set the FlushModeType to use for this query.

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

Specified by:

setFlushMode in interface CommonQueryContractImplementor

Specified by:

setFlushMode in interface ProcedureCall

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface QueryImplementor<R>

Specified by:

setFlushMode in interface StoredProcedureQuery

See Also:

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

setQueryFlushMode

@Nonnull
ProcedureCallImplementor<R> setQueryFlushMode(@Nonnull
 QueryFlushMode queryFlushMode)

Description copied from interface: CommonQueryContract

Set the QueryFlushMode to use for this query.

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

Specified by:

setQueryFlushMode in interface CommonQueryContract

Specified by:

setQueryFlushMode in interface CommonQueryContractImplementor

Specified by:

setQueryFlushMode in interface ProcedureCall

Specified by:

setQueryFlushMode in interface Query

Specified by:

setQueryFlushMode in interface Query<R>

Specified by:

setQueryFlushMode in interface QueryImplementor<R>

Specified by:

setQueryFlushMode in interface StoredProcedureQuery

See Also:

• Session.getHibernateFlushMode()

setTimeout

@Nonnull
ProcedureCallImplementor<R> setTimeout(@Nullable
 Integer timeout)

Description copied from interface: CommonQueryContract

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

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface ProcedureCall

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface QueryImplementor<R>

Specified by:

setTimeout in interface StoredProcedureQuery

See Also:

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

setTimeout

@Nonnull
ProcedureCallImplementor<R> setTimeout(int timeout)

Description copied from interface: CommonQueryContract

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

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface ProcedureCall

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface QueryImplementor<R>

See Also:

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

setTimeout

@Nonnull
ProcedureCallImplementor<R> setTimeout(@Nullable
 Timeout timeout)

Description copied from interface: CommonQueryContract

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

Specified by:

setTimeout in interface CommonQueryContract

Specified by:

setTimeout in interface CommonQueryContractImplementor

Specified by:

setTimeout in interface ProcedureCall

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface Query<R>

Specified by:

setTimeout in interface QueryImplementor<R>

Specified by:

setTimeout in interface StoredProcedureQuery

setComment

@Nonnull
ProcedureCallImplementor<R> setComment(@Nullable
 String comment)

Description copied from interface: CommonQueryContract

Set the comment for this query.

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

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

Specified by:

setComment in interface CommonQueryContract

Specified by:

setComment in interface CommonQueryContractImplementor

Specified by:

setComment in interface ProcedureCall

Specified by:

setComment in interface Query<R>

Specified by:

setComment in interface QueryImplementor<R>

See Also:

• CommonQueryContract.getComment()

addQueryHint

@Nonnull
ProcedureCallImplementor<R> addQueryHint(@Nonnull
 String hint)

Description copied from interface: CommonQueryContract

Add a database query hint to the SQL query.

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

Specified by:

addQueryHint in interface CommonQueryContract

Specified by:

addQueryHint in interface CommonQueryContractImplementor

Specified by:

addQueryHint in interface ProcedureCall

Specified by:

addQueryHint in interface Query<R>

Specified by:

addQueryHint in interface QueryImplementor<R>

setCacheRetrieveMode

@Nonnull
ProcedureCallImplementor<R> setCacheRetrieveMode(@Nonnull
 CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface CommonQueryContractImplementor

Specified by:

setCacheRetrieveMode in interface ProcedureCall

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<R>

Specified by:

setCacheRetrieveMode in interface QueryImplementor<R>

Specified by:

setCacheRetrieveMode in interface StoredProcedureQuery

setCacheStoreMode

@Nonnull
ProcedureCallImplementor<R> setCacheStoreMode(@Nonnull
 CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface CommonQueryContractImplementor

Specified by:

setCacheStoreMode in interface ProcedureCall

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<R>

Specified by:

setCacheStoreMode in interface QueryImplementor<R>

Specified by:

setCacheStoreMode in interface StoredProcedureQuery

setMaxResults

@Nonnull
ProcedureCallImplementor<R> setMaxResults(int maxResults)

Specified by:

setMaxResults in interface CommonQueryContractImplementor

Specified by:

setMaxResults in interface ProcedureCall

Specified by:

setMaxResults in interface Query

Specified by:

setMaxResults in interface Query<R>

Specified by:

setMaxResults in interface QueryImplementor<R>

setFirstResult

@Nonnull
ProcedureCallImplementor<R> setFirstResult(int startPosition)

Specified by:

setFirstResult in interface CommonQueryContractImplementor

Specified by:

setFirstResult in interface ProcedureCall

Specified by:

setFirstResult in interface Query

Specified by:

setFirstResult in interface Query<R>

Specified by:

setFirstResult in interface QueryImplementor<R>

setLockMode

@Nonnull
ProcedureCallImplementor<R> setLockMode(@Nonnull
 LockModeType lockMode)

Specified by:

setLockMode in interface CommonQueryContractImplementor

Specified by:

setLockMode in interface ProcedureCall

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface QueryImplementor<R>

setHint

@Nonnull
ProcedureCallImplementor<R> setHint(@Nonnull
 String hintName,
 @Nullable
 Object value)

Description copied from interface: CommonQueryContract

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

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

The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface CommonQueryContractImplementor

Specified by:

setHint in interface ProcedureCall

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface QueryImplementor<R>

Specified by:

setHint in interface StoredProcedureQuery

See Also:

• HibernateHints
• SpecHints

getParameterMetadata

@Nonnull
ProcedureParameterMetadataImplementor getParameterMetadata()

Description copied from interface: CommonQueryContract

Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.

Specified by:

getParameterMetadata in interface CommonQueryContract

getParameterStrategy

@Nonnull
ParameterStrategy getParameterStrategy()

getParameterBindings

@Nonnull
QueryParameterBindings getParameterBindings()

Specified by:

getParameterBindings in interface CommonQueryContractImplementor

Specified by:

getParameterBindings in interface QueryImplementor<R>

getFunctionReturn

@Nullable
FunctionReturnImplementor<?> getFunctionReturn()

Description copied from interface: ProcedureCall

The FunctionReturn describing the return value of the function, or null if this ProcedureCall is not a function call.

Specified by:

getFunctionReturn in interface ProcedureCall

registerResultParameter

@Nonnull
<T> FunctionReturnImplementor<T> registerResultParameter(Class<T> resultType)

Specified by:

registerResultParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

@Nonnull
ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
 Class<?> type,
 ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

@Nonnull
ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName,
 Class<?> type,
 ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

@Nonnull
ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
 Type<?> type,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Like ProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

registerStoredProcedureParameter

@Nonnull
ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName,
 Type<?> type,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Like ProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

registerConvertedParameter

@Nonnull
<T> ProcedureParameterImplementor<T> registerConvertedParameter(int position,
 Class<? extends AttributeConverter<T,?>> converter,
 ParameterMode mode)

Specified by:

registerConvertedParameter in interface StoredProcedureQuery

registerConvertedParameter

@Nonnull
<T> ProcedureParameterImplementor<T> registerConvertedParameter(String parameterName,
 Class<? extends AttributeConverter<T,?>> converter,
 ParameterMode mode)

Specified by:

registerConvertedParameter in interface StoredProcedureQuery

registerParameter

@Nonnull
<T> ProcedureParameterImplementor<T> registerParameter(int position,
 Class<T> type,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Basic form for registering a positional parameter.

Specified by:

registerParameter in interface ProcedureCall

Specified by:

registerParameter in interface StoredProcedureQuery

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

position - The position

type - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

registerParameter

@Nonnull
<T> ProcedureParameterImplementor<T> registerParameter(int position,
 Type<T> type,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Basic form for registering a positional parameter.

Specified by:

registerParameter in interface ProcedureCall

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

position - The position

type - The type reference of the parameter type

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

registerParameter

@Nonnull
<T> ProcedureParameterImplementor<T> registerParameter(String parameterName,
 Class<T> type,
 ParameterMode mode)
                                                throws NamedParametersNotSupportedException

Description copied from interface: ProcedureCall

Basic form for registering a named parameter.

Specified by:

registerParameter in interface ProcedureCall

Specified by:

registerParameter in interface StoredProcedureQuery

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

parameterName - The parameter name

type - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

Throws:

NamedParametersNotSupportedException - When the underlying database is known to not support named procedure parameters.

registerParameter

@Nonnull
<T> ProcedureParameterImplementor<T> registerParameter(String parameterName,
 Type<T> type,
 ParameterMode mode)
                                                throws NamedParametersNotSupportedException

Description copied from interface: ProcedureCall

Basic form for registering a named parameter.

Specified by:

registerParameter in interface ProcedureCall

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

parameterName - The parameter name

type - The type reference of the parameter type

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

Throws:

NamedParametersNotSupportedException - When the underlying database is known to not support named procedure parameters.

getParameterRegistration

@Nonnull
ProcedureParameterImplementor<?> getParameterRegistration(int position)

Description copied from interface: ProcedureCall

Retrieve a previously registered parameter memento by the position under which it was registered.

Specified by:

getParameterRegistration in interface ProcedureCall

Parameters:

position - The parameter position

Returns:

The parameter registration memento

getParameterRegistration

@Nonnull
ProcedureParameterImplementor<?> getParameterRegistration(@Nonnull
 String name)

Description copied from interface: ProcedureCall

Retrieve a previously registered parameter memento by the name under which it was registered.

Specified by:

getParameterRegistration in interface ProcedureCall

Parameters:

name - The parameter name

Returns:

The parameter registration memento

setParameter

@Nonnull
<T> ProcedureCallImplementor<R> setParameter(@Nonnull
 Parameter<T> param,
 @Nullable
 T value)

Description copied from interface: Query

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(Parameter, Object)

setParameter

@Deprecated
@Nonnull
ProcedureCallImplementor<R> setParameter(@Nonnull
 Parameter<Calendar> param,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated
@Nonnull
ProcedureCallImplementor<R> setParameter(@Nonnull
 Parameter<Date> param,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

@Nonnull
ProcedureCallImplementor<R> 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 CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

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

setParameter

@Deprecated
@Nonnull
ProcedureCallImplementor<R> setParameter(@Nonnull
 String name,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
@Nonnull
ProcedureCallImplementor<R> setParameter(@Nonnull
 String name,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Nonnull
<P> ProcedureCallImplementor<R> 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 CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

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

setParameter

@Nonnull
<P> ProcedureCallImplementor<R> 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 CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

setParameter

@Nonnull
ProcedureCallImplementor<R> 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 CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

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

setParameters

@Nonnull
ProcedureCallImplementor<R> setParameters(@Nonnull
 Object... arguments)

Description copied from interface: Query

Specified by:

setParameters in interface CommonQueryContract

Specified by:

setParameters in interface CommonQueryContractImplementor

Specified by:

setParameters in interface ProcedureCall

Specified by:

setParameters in interface Query

Specified by:

setParameters in interface Query<R>

Specified by:

setParameters in interface QueryImplementor<R>

Specified by:

setParameters in interface StoredProcedureQuery

See Also:

• Query.setParameters(Object...)

setParameter

@Nonnull
<P> ProcedureCallImplementor<R> 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 CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• CommonQueryContract.setParameter(int, Object, Type)

setParameter

@Nonnull
<P> ProcedureCallImplementor<R> 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 CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

setParameter

@Deprecated
@Nonnull
ProcedureCallImplementor<R> setParameter(int position,
 @Nullable
 Calendar value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Deprecated
@Nonnull
ProcedureCallImplementor<R> setParameter(int position,
 @Nullable
 Date value,
 @Nonnull
 TemporalType temporalType)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface CommonQueryContractImplementor

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface StoredProcedureQuery

See Also:

• Query.setParameter(int, Date, TemporalType)

setProperties

@Nonnull
ProcedureCallImplementor<R> 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

Specified by:

setProperties in interface CommonQueryContractImplementor

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Parameters:

bean - any JavaBean or POJO

Returns:

this, for method chaining

setProperties

@Nonnull
ProcedureCallImplementor<R> 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

Specified by:

setProperties in interface CommonQueryContractImplementor

Specified by:

setProperties in interface Query<R>

Specified by:

setProperties in interface QueryImplementor<R>

Parameters:

bean - a Map of names to arguments

Returns:

this, for method chaining

setConvertedParameter

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

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface CommonQueryContractImplementor

Specified by:

setConvertedParameter in interface ProcedureCall

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<R>

Specified by:

setConvertedParameter in interface QueryImplementor<R>

Specified by:

setConvertedParameter in interface StoredProcedureQuery

See Also:

• Query.setConvertedParameter(String, Object, Class)

setConvertedParameter

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

Description copied from interface: Query

Specified by:

setConvertedParameter in interface CommonQueryContract

Specified by:

setConvertedParameter in interface CommonQueryContractImplementor

Specified by:

setConvertedParameter in interface ProcedureCall

Specified by:

setConvertedParameter in interface Query

Specified by:

setConvertedParameter in interface Query<R>

Specified by:

setConvertedParameter in interface QueryImplementor<R>

Specified by:

setConvertedParameter in interface StoredProcedureQuery

See Also:

• Query.setConvertedParameter(int, Object, Class)

getResultList

@Nonnull
List<R> getResultList()

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

Specified by:

getResultList in interface StoredProcedureQuery

Returns:

the results as a list

getSingleResult

R getSingleResult()

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

Specified by:

getSingleResult in interface StoredProcedureQuery

Returns:

the single result, only if there is exactly one

toMemento

@Nonnull
NamedCallableQueryMemento toMemento(String name)

Description copied from interface: NameableQuery

Convert this query into the memento.

Specified by:

toMemento in interface NameableQuery

See Also:

• EntityManagerFactory.addNamedQuery(String, Query)
• NamedObjectRepository.registerNamedQuery(String, TypedQuery)
• NamedObjectRepository.registerNamedMutation(String, Statement)
• NamedObjectRepository.registerCallableQueryMemento(String, NamedCallableQueryMemento)