Top Fields Methods
org.hibernate.procedure.spi

public Interface ProcedureCallImplementor<R>

extends ProcedureCall, QueryImplementor<R>
Known Direct Implementers
org.hibernate.procedure.internal.ProcedureCallImpl
Imports
java.util.Calendar, .Date, .List, org.hibernate.procedure.ProcedureCall, org.hibernate.query.spi.ProcedureParameterMetadataImplementor, .QueryImplementor, org.hibernate.type.BasicTypeReference, jakarta.persistence.FlushModeType, .Parameter, .ParameterMode, .TemporalType
Author
Steve Ebersole

Field Summary

Inherited from org.hibernate.procedure.ProcedureCall:
FUNCTION_RETURN_TYPE_HINT

Method Summary

Modifier and TypeMethod and Description
public FunctionReturnImplementor<T>
getFunctionReturn()

public ProcedureParameterMetadataImplementor
getParameterMetadata()

Redeclares org.hibernate.query.Query.getParameterMetadata.

Access to information about query parameters.
public ParameterStrategy
getParameterStrategy()

public default List<R>
getResultList()

Overrides default org.hibernate.query.Query.getResultList.

Implements jakarta.persistence.StoredProcedureQuery.getResultList.

Retrieve the list of results from the next result set.
public R
getSingleResult()

Redeclares jakarta.persistence.StoredProcedureQuery.getSingleResult, org.hibernate.query.Query.getSingleResult.

Retrieve a single result from the next result set.
public ProcedureCallImplementor<R>
registerStoredProcedureParameter(int position, BasicTypeReference<?> type, ParameterMode mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Like registerStoredProcedureParameter(int, Class, ParameterMode) but a basic type reference is given instead of a class for the parameter type.
public ProcedureCallImplementor<R>
registerStoredProcedureParameter(String parameterName, BasicTypeReference<?> type, ParameterMode mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Like registerStoredProcedureParameter(String, Class, ParameterMode) but a basic type reference is given instead of a class for the parameter type.
public ProcedureCallImplementor<R>
registerStoredProcedureParameter(int
parameter position
position, Class<T>
type of the parameter
type, ParameterMode
parameter mode
mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Register a positional parameter.
public ProcedureCallImplementor<R>
registerStoredProcedureParameter(String
name of the parameter as registered or specified in metadata
parameterName, Class<T>
type of the parameter
type, ParameterMode
parameter mode
mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Register a named parameter.
public ProcedureCallImplementor<R>
setFlushMode(FlushModeType
flush mode
flushMode)

Redeclares org.hibernate.procedure.ProcedureCall.setFlushMode, org.hibernate.query.Query.setFlushMode.

Set the FlushMode in to use for this query.
public ProcedureCallImplementor<R>
setHint(String
name of the property or hint
hintName, Object
value for the property or hint
value)

Redeclares org.hibernate.procedure.ProcedureCall.setHint, org.hibernate.query.Query.setHint.

Set a hint.
public <T> ProcedureCallImplementor<R>
setParameter(Parameter<T>
parameter object
param, T
parameter value
value)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind the value of a Parameter object.
public ProcedureCallImplementor<R>
setParameter(Parameter<Calendar>
parameter object
param, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind an instance of java.util.Calendar to a Parameter object.
public ProcedureCallImplementor<R>
setParameter(Parameter<Date>
parameter object
param, Date
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind an instance of java.util.Date to a Parameter object.
public ProcedureCallImplementor<R>
setParameter(String
parameter name
name, Object
parameter value
value)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind the given argument to a named query parameter.
public ProcedureCallImplementor<R>
setParameter(String
parameter name
name, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind an instance of java.util.Calendar to a named parameter.
public ProcedureCallImplementor<R>
setParameter(String
parameter name
name, Date
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind an instance of java.util.Date to a named parameter.
public ProcedureCallImplementor<R>
setParameter(int
position
position, Object
parameter value
value)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind the given argument to an ordinal query parameter.
public ProcedureCallImplementor<R>
setParameter(int
position
position, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind an instance of java.util.Calendar to a positional parameter.
public ProcedureCallImplementor<R>
setParameter(int
position
position, Date
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Bind an instance of java.util.Date to a positional parameter.
Inherited from org.hibernate.procedure.ProcedureCall:
addSynchronizedEntityClassaddSynchronizedEntityNameaddSynchronizedQuerySpaceclosegetOutputsgetParameterRegistrationgetParameterRegistrationgetProcedureNamegetRegisteredParametersisFunctionCallmarkAsFunctionCallmarkAsFunctionCallmarkAsFunctionCallregisterParameterregisterParameterregisterParameterregisterParametertoMemento
Inherited from org.hibernate.query.spi.QueryImplementor:
getParameterBindingsgetSessionscrollscrollsetOptionalEntityNamesetOptionalIdsetOptionalObjectsetParametersetParametersetParametersetParametersetParametersetParametersetParametersetParametersetParametersetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetParameterListsetPropertiessetPropertiessetResultListTransformersetResultTransformersetTupleTransformer

Method Detail

getFunctionReturnback to summary
public FunctionReturnImplementor<T> getFunctionReturn()
getParameterMetadataback to summary
public ProcedureParameterMetadataImplementor getParameterMetadata()

Redeclares org.hibernate.query.Query.getParameterMetadata.

Doc from org.hibernate.query.Query.getParameterMetadata.

Access to information about query parameters.

Returns:ProcedureParameterMetadataImplementor

information about query parameters.

Annotations
@Override
getParameterStrategyback to summary
public ParameterStrategy getParameterStrategy()
getResultListback to summary
public default List<R> getResultList()

Overrides default org.hibernate.query.Query.getResultList.

Implements jakarta.persistence.StoredProcedureQuery.getResultList.

Doc from jakarta.persistence.StoredProcedureQuery.getResultList.

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.

Returns:List<R>

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

Annotations
@Override
getSingleResultback to summary
public R getSingleResult()

Redeclares jakarta.persistence.StoredProcedureQuery.getSingleResult, org.hibernate.query.Query.getSingleResult.

Doc from jakarta.persistence.StoredProcedureQuery.getSingleResult.

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.

Returns:R

the result or null if the next item is not a result set

Annotations
@Override
registerStoredProcedureParameterback to summary
public ProcedureCallImplementor<R> registerStoredProcedureParameter(int position, BasicTypeReference<?> type, ParameterMode mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Doc from org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

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

Annotations
@Override
registerStoredProcedureParameterback to summary
public ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName, BasicTypeReference<?> type, ParameterMode mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Doc from org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

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

Annotations
@Override
registerStoredProcedureParameterback to summary
public ProcedureCallImplementor<R> registerStoredProcedureParameter(int position, Class<T> type, ParameterMode mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Doc from jakarta.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Register a positional parameter. All parameters must be registered.

Parameters
position:int

parameter position

type:Class<T>

type of the parameter

mode:ParameterMode

parameter mode

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
registerStoredProcedureParameterback to summary
public ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName, Class<T> type, ParameterMode mode)

Redeclares org.hibernate.procedure.ProcedureCall.registerStoredProcedureParameter.

Doc from jakarta.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Register a named parameter.

Parameters
parameterName:String

name of the parameter as registered or specified in metadata

type:Class<T>

type of the parameter

mode:ParameterMode

parameter mode

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setFlushModeback to summary
public ProcedureCallImplementor<R> setFlushMode(FlushModeType flushMode)

Redeclares org.hibernate.procedure.ProcedureCall.setFlushMode, org.hibernate.query.Query.setFlushMode.

Doc from org.hibernate.query.CommonQueryContract.setFlushMode.

Set the FlushMode in to use for this query.

Parameters
flushMode:FlushModeType

Doc from jakarta.persistence.StoredProcedureQuery.setFlushMode.

flush mode

Returns:ProcedureCallImplementor<R>

Doc from jakarta.persistence.StoredProcedureQuery.setFlushMode.

the same query instance

Annotations
@Override
setHintback to summary
public ProcedureCallImplementor<R> setHint(String hintName, Object value)

Redeclares org.hibernate.procedure.ProcedureCall.setHint, org.hibernate.query.Query.setHint.

Doc from org.hibernate.query.CommonQueryContract.setHint.

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

Parameters
hintName:String

Doc from jakarta.persistence.StoredProcedureQuery.setHint.

name of the property or hint

value:Object

Doc from jakarta.persistence.StoredProcedureQuery.setHint.

value for the property or hint

Returns:ProcedureCallImplementor<R>

Doc from jakarta.persistence.StoredProcedureQuery.setHint.

the same query instance

Annotations
@Override
setParameterback to summary
public <T> ProcedureCallImplementor<R> setParameter(Parameter<T> param, T value)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

Bind the value of a Parameter object.

Parameters
param:Parameter<T>

parameter object

value:T

parameter value

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

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

Parameters
param:Parameter<Calendar>

parameter object

value:Calendar

parameter value

temporalType:TemporalType

temporal type

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(Parameter<Date> param, Date value, TemporalType temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

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

Parameters
param:Parameter<Date>

parameter object

value:Date

parameter value

temporalType:TemporalType

temporal type

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(String name, Object value)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from org.hibernate.query.CommonQueryContract.setParameter.

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".

Parameters
name:String

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

parameter name

value:Object

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

parameter value

Returns:ProcedureCallImplementor<R>

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(String name, Calendar value, TemporalType temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

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

Parameters
name:String

parameter name

value:Calendar

parameter value

temporalType:TemporalType

temporal type

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(String name, Date value, TemporalType temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

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

Parameters
name:String

parameter name

value:Date

parameter value

temporalType:TemporalType

temporal type

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(int position, Object value)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from org.hibernate.query.CommonQueryContract.setParameter.

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".

Parameters
position:int

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

position

value:Object

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

parameter value

Returns:ProcedureCallImplementor<R>

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(int position, Calendar value, TemporalType temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

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

Parameters
position:int

position

value:Calendar

parameter value

temporalType:TemporalType

temporal type

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override
setParameterback to summary
public ProcedureCallImplementor<R> setParameter(int position, Date value, TemporalType temporalType)

Redeclares org.hibernate.procedure.ProcedureCall.setParameter, org.hibernate.query.spi.QueryImplementor.setParameter.

Doc from jakarta.persistence.StoredProcedureQuery.setParameter.

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

Parameters
position:int

position

value:Date

parameter value

temporalType:TemporalType

temporal type

Returns:ProcedureCallImplementor<R>

the same query instance

Annotations
@Override