Top 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, javax.persistence.FlushModeType, .Parameter, .ParameterMode, .TemporalType, org.hibernate.procedure.ProcedureCall, org.hibernate.query.spi.QueryImplementor

Deprecated

as a consequence of ProcedureCall and QueryImplementor being deprecated. See corresponding docs for further information.

Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public default List<R>
getResultList()

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

Implements javax.persistence.StoredProcedureQuery.getResultList.

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

Overrides default org.hibernate.query.Query.getSingleResult.

Implements javax.persistence.StoredProcedureQuery.getSingleResult.

Retrieve a single result from the next result set.
public ProcedureCallImplementor<R>
registerStoredProcedureParameter(int
parameter position
position, Class<T>
type of the parameter
type, ParameterMode
parameter mode
mode)

Redeclares javax.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
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 javax.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
Register a named parameter.
public ProcedureCallImplementor<R>
setFlushMode(FlushModeType
flush mode
flushMode)

Redeclares javax.persistence.StoredProcedureQuery.setFlushMode, org.hibernate.query.Query.setFlushMode.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
Set the flush mode type to be used for the query execution.
public ProcedureCallImplementor<R>
setHint(String
name of the property or hint
hintName, Object
value for the property or hint
value)

Redeclares javax.persistence.StoredProcedureQuery.setHint, org.hibernate.query.Query.setHint.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
Set a query property or hint.
public <T> ProcedureCallImplementor<R>
setParameter(Parameter<T>
parameter object
param, T
parameter value
value)

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

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

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
Bind an argument value to a named parameter.
public ProcedureCallImplementor<R>
setParameter(String
parameter name
name, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

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

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
Bind an argument value to a positional parameter.
public ProcedureCallImplementor<R>
setParameter(int
position
position, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Deprecated as a consequence of ProcedureCallImplementor being deprecated.
Bind an instance of java.util.Date to a positional parameter.
Inherited from org.hibernate.procedure.ProcedureCall:
addSynchronizedEntityClassaddSynchronizedEntityNameaddSynchronizedQuerySpaceextractMementoextractMementogetOutputsgetParameterRegistrationgetParameterRegistrationgetProcedureNamegetRegisteredParametersregisterParameterregisterParameterregisterParameter0registerParameter0
Inherited from org.hibernate.query.spi.QueryImplementor:
getProducersetOptionalEntityNamesetOptionalIdsetOptionalObject

Method Detail

getResultListback to summary
public default List<R> getResultList()

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

Implements javax.persistence.StoredProcedureQuery.getResultList.

Doc from javax.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 default R getSingleResult()

Overrides default org.hibernate.query.Query.getSingleResult.

Implements javax.persistence.StoredProcedureQuery.getSingleResult.

Doc from javax.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, Class<T> type, ParameterMode mode)

Redeclares javax.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Doc from javax.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Doc from javax.persistence.StoredProcedureQuery.registerStoredProcedureParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setFlushMode, org.hibernate.query.Query.setFlushMode.

Doc from javax.persistence.StoredProcedureQuery.setFlushMode.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

Set the flush mode type to be used for the query execution. The flush mode type applies to the query regardless of the flush mode type in use for the entity manager.

Parameters
flushMode:FlushModeType

flush mode

Returns:ProcedureCallImplementor<R>

the same query instance

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

Redeclares javax.persistence.StoredProcedureQuery.setHint, org.hibernate.query.Query.setHint.

Doc from javax.persistence.StoredProcedureQuery.setHint.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use, this hint may or may not be observed.

Parameters
hintName:String

name of the property or hint

value:Object

value for the property or hint

Returns:ProcedureCallImplementor<R>

the same query instance

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

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

Bind an argument value to a named parameter.

Parameters
name:String

parameter name

value:Object

parameter value

Returns:ProcedureCallImplementor<R>

the same query instance

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

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

Bind an argument value to a positional parameter.

Parameters
position:int

position

value:Object

parameter value

Returns:ProcedureCallImplementor<R>

the same query instance

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

Redeclares javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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 javax.persistence.StoredProcedureQuery.setParameter, org.hibernate.query.Query.setParameter, org.hibernate.query.Query.setParameter.

Doc from javax.persistence.StoredProcedureQuery.setParameter.

Deprecated

as a consequence of ProcedureCallImplementor being deprecated. See corresponding docs for further information.

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