Package org.hibernate.procedure.spi

Interface ProcedureCallImplementor<R>

All Superinterfaces:

AutoCloseable, CommonQueryContract, NameableQuery, ProcedureCall, jakarta.persistence.Query, Query<R>, QueryImplementor<R>, jakarta.persistence.StoredProcedureQuery, SynchronizeableQuery, jakarta.persistence.TypedQuery<R>

All Known Implementing Classes:

ProcedureCallImpl

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

Field Summary

Fields inherited from interface org.hibernate.procedure.ProcedureCall

FUNCTION_RETURN_TYPE_HINT

Method Summary

Modifier and Type	Method	Description
ParameterStrategy	getParameterStrategy()
default List<R>	getResultList()
default R	getSingleResult()
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, Class type, jakarta.persistence.ParameterMode mode)
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, BasicTypeReference<?> type, jakarta.persistence.ParameterMode mode)	Like ProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode) but a basic type reference is given instead of a class for the parameter type.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, Class type, jakarta.persistence.ParameterMode mode)
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, BasicTypeReference<?> type, jakarta.persistence.ParameterMode mode)	Like ProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode) but a basic type reference is given instead of a class for the parameter type.
ProcedureCallImplementor<R>	setFlushMode(jakarta.persistence.FlushModeType flushMode)
ProcedureCallImplementor<R>	setHint(String hintName, Object value)
ProcedureCallImplementor<R>	setParameter(int position, Object value)	Bind a positional query parameter using its inferred Type.
ProcedureCallImplementor<R>	setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)
ProcedureCallImplementor<R>	setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)
ProcedureCallImplementor<R>	setParameter(jakarta.persistence.Parameter<Calendar> param, Calendar value, jakarta.persistence.TemporalType temporalType)
ProcedureCallImplementor<R>	setParameter(jakarta.persistence.Parameter<Date> param, Date value, jakarta.persistence.TemporalType temporalType)
<T> ProcedureCallImplementor<R>	setParameter(jakarta.persistence.Parameter<T> param, T value)
ProcedureCallImplementor<R>	setParameter(String name, Object value)	Bind a named query parameter using its inferred Type.
ProcedureCallImplementor<R>	setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)
ProcedureCallImplementor<R>	setParameter(String name, Date value, jakarta.persistence.TemporalType temporalType)

Methods inherited from interface org.hibernate.query.CommonQueryContract

getCacheMode, getCacheRegion, getFetchSize, getHibernateFlushMode, getTimeout, isCacheable, isReadOnly

Methods inherited from interface org.hibernate.procedure.ProcedureCall

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

Methods inherited from interface jakarta.persistence.Query

getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Methods inherited from interface org.hibernate.query.Query

addQueryHint, applyFetchGraph, applyGraph, applyLoadGraph, getComment, getLockOptions, getParameterMetadata, getQueryOptions, getQueryString, getResultStream, list, setCacheable, setCacheMode, setCacheRegion, setComment, setFetchSize, setFirstResult, setHibernateFlushMode, setLockMode, setLockMode, setLockOptions, setMaxResults, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setProperties, setProperties, setReadOnly, setResultListTransformer, setResultTransformer, setTimeout, setTupleTransformer, stream, uniqueResult, uniqueResultOptional

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

getParameterBindings, getSession, scroll, scroll, setOptionalEntityName, setOptionalId, setOptionalObject

Methods inherited from interface jakarta.persistence.StoredProcedureQuery

execute, executeUpdate, getOutputParameterValue, getOutputParameterValue, getUpdateCount, hasMoreResults

Methods inherited from interface org.hibernate.SynchronizeableQuery

addSynchronizedEntityClass, addSynchronizedEntityName, addSynchronizedQuerySpace, addSynchronizedTable, addSynchronizedTable, getSynchronizedQuerySpaces

Method Detail

getResultList

default List<R> getResultList()

Specified by:

getResultList in interface jakarta.persistence.Query

Specified by:

getResultList in interface Query<R>

Specified by:

getResultList in interface jakarta.persistence.StoredProcedureQuery

Specified by:

getResultList in interface jakarta.persistence.TypedQuery<R>

getParameterStrategy

ParameterStrategy getParameterStrategy()

getSingleResult

default R getSingleResult()

Specified by:

getSingleResult in interface jakarta.persistence.Query

Specified by:

getSingleResult in interface Query<R>

Specified by:

getSingleResult in interface jakarta.persistence.StoredProcedureQuery

Specified by:

getSingleResult in interface jakarta.persistence.TypedQuery<R>

registerStoredProcedureParameter

ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
                                                             BasicTypeReference<?> type,
                                                             jakarta.persistence.ParameterMode mode)

Description copied from interface: ProcedureCall

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

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

registerStoredProcedureParameter

ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName,
                                                             BasicTypeReference<?> type,
                                                             jakarta.persistence.ParameterMode mode)

Description copied from interface: ProcedureCall

Like ProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode) but a basic 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)

Specified by:

setHint in interface ProcedureCall

Specified by:

setHint in interface jakarta.persistence.Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setHint in interface jakarta.persistence.TypedQuery<R>

setParameter

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

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setParameter

ProcedureCallImplementor<R> setParameter(jakarta.persistence.Parameter<Calendar> param,
                                         Calendar value,
                                         jakarta.persistence.TemporalType temporalType)

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setParameter

ProcedureCallImplementor<R> setParameter(jakarta.persistence.Parameter<Date> param,
                                         Date value,
                                         jakarta.persistence.TemporalType temporalType)

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setParameter

ProcedureCallImplementor<R> setParameter(String name,
                                         Object value)

Description copied from interface: Query

Bind a named query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(String, Object, AllowableParameterType) should be used instead

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

Parameters:

name - the parameter name

value - the (possibly-null) parameter value

Returns:

this, for method chaining

setParameter

ProcedureCallImplementor<R> setParameter(String name,
                                         Calendar value,
                                         jakarta.persistence.TemporalType temporalType)

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setParameter

ProcedureCallImplementor<R> setParameter(String name,
                                         Date value,
                                         jakarta.persistence.TemporalType temporalType)

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setParameter

ProcedureCallImplementor<R> setParameter(int position,
                                         Object value)

Description copied from interface: Query

Bind a positional query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(int, Object, AllowableParameterType) should be used instead

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

Parameters:

position - the position of the parameter in the query string, numbered from 0.

value - the possibly-null parameter value

Returns:

this, for method chaining

setParameter

ProcedureCallImplementor<R> setParameter(int position,
                                         Calendar value,
                                         jakarta.persistence.TemporalType temporalType)

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setParameter

ProcedureCallImplementor<R> setParameter(int position,
                                         Date value,
                                         jakarta.persistence.TemporalType temporalType)

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery<R>

setFlushMode

ProcedureCallImplementor<R> setFlushMode(jakarta.persistence.FlushModeType flushMode)

Specified by:

setFlushMode in interface ProcedureCall

Specified by:

setFlushMode in interface jakarta.persistence.Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setFlushMode in interface jakarta.persistence.TypedQuery<R>

registerStoredProcedureParameter

ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
                                                             Class type,
                                                             jakarta.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface jakarta.persistence.StoredProcedureQuery

registerStoredProcedureParameter

ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName,
                                                             Class type,
                                                             jakarta.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface jakarta.persistence.StoredProcedureQuery