Package org.hibernate.procedure.spi

Interface ProcedureCallImplementor<R>

All Superinterfaces:

AutoCloseable, CommonQueryContract, MutationQuery, NameableQuery, ProcedureCall, Query, Query<R>, QueryImplementor<R>, SelectionQuery<R>, StoredProcedureQuery, SynchronizeableQuery, TypedQuery<R>

All Known Implementing Classes:

ProcedureCallImpl

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

Field Summary

Fields inherited from interface org.hibernate.procedure.ProcedureCall

FUNCTION_RETURN_TYPE_HINT

Method Summary

Modifier and Type	Method	Description
FunctionReturnImplementor<R>	getFunctionReturn()	The FunctionReturn describing the return value of the function, or null if this ProcedureCall is not a function call.
ProcedureParameterMetadataImplementor	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
ParameterStrategy	getParameterStrategy()
default List<R>	getResultList()	Execute the query and return the query results as a List.
R	getSingleResult()	Execute the query and return the single result of the query, throwing an exception if the query returns no results.
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>	setFlushMode(FlushModeType flushMode)	Set the FlushMode to use for this query.
ProcedureCallImplementor<R>	setHint(String hintName, Object value)	Set a hint.
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.
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)	Query override
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.
ProcedureCallImplementor<R>	setTimeout(Integer timeout)
NamedCallableQueryMemento	toMemento(String name)	Convert this query into the memento.

Methods inherited from interface org.hibernate.query.CommonQueryContract

getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout

Methods inherited from interface org.hibernate.procedure.ProcedureCall

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

Methods inherited from interface jakarta.persistence.Query

getCacheRetrieveMode, getCacheStoreMode, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getTimeout, isBound, unwrap

Methods inherited from interface org.hibernate.query.Query

addQueryHint, applyFetchGraph, applyGraph, applyLoadGraph, disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getLockOptions, getQueryOptions, getQueryString, getResultStream, list, setCacheable, setCacheMode, setCacheRegion, setComment, setEntityGraph, setFetchSize, setFirstResult, setHibernateFlushMode, setLockMode, setLockOptions, setLockScope, setMaxResults, setPage, setQueryFlushMode, setReadOnly, setTimeout, setTimeout, stream, uniqueResult, uniqueResultOptional

Methods inherited from interface org.hibernate.query.spi.QueryImplementor

getParameterBindings, getSession, scroll, scroll, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setProperties, setProperties, setResultListTransformer, setResultTransformer, setTupleTransformer

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getKeyedResultList, getLockMode, getMaxResults, getResultCount, getSingleResultOrNull, isCacheable, isQueryPlanCacheable, isReadOnly, setFollowOnLocking, setFollowOnStrategy, setHibernateLockMode, setLockMode, setLockScope, setQueryPlanCacheable

Methods inherited from interface jakarta.persistence.StoredProcedureQuery

execute, executeUpdate, getOutputParameterValue, getOutputParameterValue, getSingleResultOrNull, getUpdateCount, hasMoreResults

Methods inherited from interface org.hibernate.query.SynchronizeableQuery

getSynchronizedQuerySpaces

Methods inherited from interface jakarta.persistence.TypedQuery

getSingleResultOrNull

Method Details

getResultList

default List<R> getResultList()

Description copied from interface: Query

Execute the query and return the query results as a List. If the query 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 SelectionQuery<R>

Specified by:

getResultList in interface StoredProcedureQuery

Specified by:

getResultList in interface TypedQuery<R>

Returns:

the results as a list

getParameterStrategy

ParameterStrategy getParameterStrategy()

getFunctionReturn

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

getParameterMetadata

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

getSingleResult

R getSingleResult()

Description copied from interface: Query

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

Specified by:

getSingleResult in interface Query

Specified by:

getSingleResult in interface Query<R>

Specified by:

getSingleResult in interface SelectionQuery<R>

Specified by:

getSingleResult in interface StoredProcedureQuery

Specified by:

getSingleResult in interface TypedQuery<R>

Returns:

the single result, only if there is exactly one

registerStoredProcedureParameter

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

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

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

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

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

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

setHint

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

Description copied from interface: CommonQueryContract

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

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface MutationQuery

Specified by:

setHint in interface ProcedureCall

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface StoredProcedureQuery

Specified by:

setHint in interface TypedQuery<R>

See Also:

• HibernateHints
• SpecHints

setParameter

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

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

ProcedureCallImplementor<R> setParameter(String name,
 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 MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

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

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

ProcedureCallImplementor<R> setParameter(int position,
 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 MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

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

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

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

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

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

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

See Also:

• Query.setParameter(int, Date, TemporalType)

setFlushMode

ProcedureCallImplementor<R> setFlushMode(FlushModeType flushMode)

Description copied from interface: CommonQueryContract

Set the FlushMode to use for this query.

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

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface ProcedureCall

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface SelectionQuery<R>

Specified by:

setFlushMode in interface StoredProcedureQuery

Specified by:

setFlushMode in interface TypedQuery<R>

See Also:

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

setCacheRetrieveMode

ProcedureCallImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<R>

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

Specified by:

setCacheRetrieveMode in interface StoredProcedureQuery

Specified by:

setCacheRetrieveMode in interface TypedQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheStoreMode

ProcedureCallImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<R>

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

Specified by:

setCacheStoreMode in interface StoredProcedureQuery

Specified by:

setCacheStoreMode in interface TypedQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setTimeout

ProcedureCallImplementor<R> setTimeout(Integer timeout)

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface StoredProcedureQuery

Specified by:

setTimeout in interface TypedQuery<R>

toMemento

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, Query)