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

Author:

Steve Ebersole

Field Summary

Fields inherited from interface org.hibernate.procedure.ProcedureCall

FUNCTION_RETURN_TYPE_HINT

Method Summary

Modifier and Type	Method	Description
FunctionReturnImplementor	getFunctionReturn()
ProcedureParameterMetadataImplementor	getParameterMetadata()	Access to information about query parameters.
ParameterStrategy	getParameterStrategy()
default List<R>	getResultList()	Retrieve the list of results from the next result set.
R	getSingleResult()	Retrieve a single result from the next result set.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, Class type, ParameterMode mode)	Register a positional parameter.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, BasicTypeReference<?> type, 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, ParameterMode mode)	Register a named parameter.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, BasicTypeReference<?> type, 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(FlushModeType flushMode)	Set the FlushMode in 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)	Bind an instance of java.util.Calendar to a positional parameter.
ProcedureCallImplementor<R>	setParameter(int position, Date value, TemporalType temporalType)	Bind an instance of java.util.Date to a positional parameter.
ProcedureCallImplementor<R>	setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)	Bind an instance of java.util.Calendar to a Parameter object.
ProcedureCallImplementor<R>	setParameter(Parameter<Date> param, Date value, TemporalType temporalType)	Bind an instance of java.util.Date to a Parameter object.
<T> ProcedureCallImplementor<R>	setParameter(Parameter<T> param, T value)	Bind the value of a Parameter object.
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)	Bind an instance of java.util.Calendar to a named parameter.
ProcedureCallImplementor<R>	setParameter(String name, Date value, TemporalType temporalType)	Bind an instance of java.util.Date to a named parameter.

Methods inherited from interface org.hibernate.query.CommonQueryContract

getFlushMode, getHibernateFlushMode, 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, 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, disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getLockOptions, getQueryOptions, getQueryString, getResultStream, list, setCacheable, setCacheMode, setCacheRegion, setCacheRetrieveMode, setCacheStoreMode, setComment, setEntityGraph, setFetchSize, setFirstResult, setHibernateFlushMode, setLockMode, setLockMode, setLockOptions, setMaxResults, setOrder, setOrder, setPage, setReadOnly, setTimeout, stream, uniqueResult, uniqueResultOptional

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

getParameterBindings, getSession, scroll, scroll, setOptionalEntityName, setOptionalId, setOptionalObject, 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, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode, setQueryPlanCacheable

Methods inherited from interface jakarta.persistence.StoredProcedureQuery

execute, executeUpdate, getOutputParameterValue, getOutputParameterValue, getUpdateCount, hasMoreResults

Methods inherited from interface org.hibernate.query.SynchronizeableQuery

getSynchronizedQuerySpaces

Method Details

getResultList

default List<R> getResultList()

Description copied from interface: StoredProcedureQuery

Retrieve the list of results from the next result set. The provider will call execute on the query if needed. A REF_CURSOR result set, if any, will be retrieved in the order the REF_CURSOR parameter was registered with the query.

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:

a list of the results or null is the next item is not a result set

getParameterStrategy

ParameterStrategy getParameterStrategy()

getFunctionReturn

FunctionReturnImplementor getFunctionReturn()

getParameterMetadata

ProcedureParameterMetadataImplementor getParameterMetadata()

Description copied from interface: Query

Access to information about query parameters.

Specified by:

getParameterMetadata in interface Query<R>

Returns:

information about query parameters.

getSingleResult

R getSingleResult()

Description copied from interface: StoredProcedureQuery

Retrieve a single result from the next result set. The provider will call execute on the query if needed. A REF_CURSOR result set, if any, will be retrieved in the order the REF_CURSOR parameter was registered with the query.

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 result or null if the next item is not a result set

registerStoredProcedureParameter

ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
 BasicTypeReference<?> type,
 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,
 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)

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>

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

See Also:

• HibernateHints
• SpecHints

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind the value of a Parameter object.

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>

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

See Also:

• Query.setParameter(Parameter, Object)

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Calendar to a Parameter object.

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>

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Date to a Parameter object.

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>

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

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 forms which accepts a "type".

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>

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, BindableType)

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Calendar to a named parameter.

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>

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Date to a named parameter.

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>

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

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 forms which accepts a "type".

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>

Parameters:

position - position

value - parameter value

Returns:

the same query instance

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, BindableType)

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Calendar to a positional parameter.

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>

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

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

Description copied from interface: StoredProcedureQuery

Bind an instance of java.util.Date to a positional parameter.

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>

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

See Also:

• Query.setParameter(int, Date, TemporalType)

setFlushMode

ProcedureCallImplementor<R> setFlushMode(FlushModeType flushMode)

Description copied from interface: CommonQueryContract

Set the FlushMode in to use for this query.

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>

Parameters:

flushMode - flush mode

Returns:

the same query instance

See Also:

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

registerStoredProcedureParameter

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

Description copied from interface: StoredProcedureQuery

Register a positional parameter. All parameters must be registered.

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

Parameters:

position - parameter position

type - type of the parameter

mode - parameter mode

Returns:

the same query instance

registerStoredProcedureParameter

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

Description copied from interface: StoredProcedureQuery

Register a named parameter.

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

Parameters:

parameterName - name of the parameter as registered or specified in metadata

type - type of the parameter

mode - parameter mode

Returns:

the same query instance