org.hibernate.procedure

Interface ProcedureCall

All Superinterfaces:

BasicQueryContract, SynchronizeableQuery

All Known Implementing Classes:

ProcedureCallImpl

public interface ProcedureCall
extends BasicQueryContract, SynchronizeableQuery

Defines support for executing database stored procedures and functions

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
ProcedureCall	addSynchronizedEntityClass(Class entityClass) Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking.
ProcedureCall	addSynchronizedEntityName(String entityName) Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking.
ProcedureCall	addSynchronizedQuerySpace(String querySpace) Adds a query space.
ProcedureCallMemento	extractMemento(Map<String,Object> hints) Extract the disconnected representation of this call.
ProcedureOutputs	getOutputs() Retrieves access to outputs of this procedure call.
ParameterRegistration	getParameterRegistration(int position) Retrieve a previously registered parameter memento by the position under which it was registered.
ParameterRegistration	getParameterRegistration(String name) Retrieve a previously registered parameter memento by the name under which it was registered.
String	getProcedureName() Get the name of the stored procedure to be called.
List<ParameterRegistration>	getRegisteredParameters() Retrieve all registered parameters.
<T> ParameterRegistration<T>	registerParameter(int position, Class<T> type, ParameterMode mode) Basic form for registering a positional parameter.
<T> ParameterRegistration<T>	registerParameter(String parameterName, Class<T> type, ParameterMode mode) Basic form for registering a named parameter.
ProcedureCall	registerParameter0(int position, Class type, ParameterMode mode) Chained form of registerParameter(int, Class, javax.persistence.ParameterMode)
ProcedureCall	registerParameter0(String parameterName, Class type, ParameterMode mode) Chained form of registerParameter(String, Class, javax.persistence.ParameterMode)

Methods inherited from interface org.hibernate.BasicQueryContract

getCacheMode, getCacheRegion, getFetchSize, getFlushMode, getReturnTypes, getTimeout, isCacheable, isReadOnly, setCacheable, setCacheMode, setCacheRegion, setFetchSize, setFlushMode, setReadOnly, setTimeout

Methods inherited from interface org.hibernate.SynchronizeableQuery

getSynchronizedQuerySpaces

Method Detail

addSynchronizedQuerySpace

ProcedureCall addSynchronizedQuerySpace(String querySpace)

Description copied from interface: SynchronizeableQuery

Adds a query space.

Specified by:

addSynchronizedQuerySpace in interface SynchronizeableQuery

Parameters:

querySpace - The query space to be auto-flushed for this query.

Returns:

this, for method chaining

addSynchronizedEntityName

ProcedureCall addSynchronizedEntityName(String entityName)
                                 throws MappingException

Description copied from interface: SynchronizeableQuery

Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking. Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.

Specified by:

addSynchronizedEntityName in interface SynchronizeableQuery

Parameters:

entityName - The name of the entity upon whose defined query spaces we should additionally synchronize.

Returns:

this, for method chaining

Throws:

MappingException - Indicates the given name could not be resolved as an entity

addSynchronizedEntityClass

ProcedureCall addSynchronizedEntityClass(Class entityClass)
                                  throws MappingException

Description copied from interface: SynchronizeableQuery

Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking. Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.

Specified by:

addSynchronizedEntityClass in interface SynchronizeableQuery

Parameters:

entityClass - The class of the entity upon whose defined query spaces we should additionally synchronize.

Returns:

this, for method chaining

Throws:

MappingException - Indicates the given class could not be resolved as an entity

getProcedureName

String getProcedureName()

Get the name of the stored procedure to be called.

Returns:

The procedure name.

registerParameter

<T> ParameterRegistration<T> registerParameter(int position,
                                               Class<T> type,
                                               ParameterMode mode)

Basic form for registering a positional parameter.

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

position - The position

type - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

registerParameter0

ProcedureCall registerParameter0(int position,
                                 Class type,
                                 ParameterMode mode)

Chained form of registerParameter(int, Class, javax.persistence.ParameterMode)

Parameters:

position - The position

type - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

this, for method chaining

getParameterRegistration

ParameterRegistration getParameterRegistration(int position)

Retrieve a previously registered parameter memento by the position under which it was registered.

Parameters:

position - The parameter position

Returns:

The parameter registration memento

Throws:

ParameterStrategyException - If the ProcedureCall is defined using named parameters

NoSuchParameterException - If no parameter with that position exists

registerParameter

<T> ParameterRegistration<T> registerParameter(String parameterName,
                                               Class<T> type,
                                               ParameterMode mode)
                                        throws NamedParametersNotSupportedException

Basic form for registering a named parameter.

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

parameterName - The parameter name

type - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

Throws:

NamedParametersNotSupportedException - When the underlying database is known to not support named procedure parameters.

registerParameter0

ProcedureCall registerParameter0(String parameterName,
                                 Class type,
                                 ParameterMode mode)
                          throws NamedParametersNotSupportedException

Chained form of registerParameter(String, Class, javax.persistence.ParameterMode)

Parameters:

parameterName - The parameter name

type - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

Throws:

NamedParametersNotSupportedException - When the underlying database is known to not support named procedure parameters.

getParameterRegistration

ParameterRegistration getParameterRegistration(String name)

Retrieve a previously registered parameter memento by the name under which it was registered.

Parameters:

name - The parameter name

Returns:

The parameter registration memento

Throws:

ParameterStrategyException - If the ProcedureCall is defined using positional parameters

NoSuchParameterException - If no parameter with that name exists

getRegisteredParameters

List<ParameterRegistration> getRegisteredParameters()

Retrieve all registered parameters.

Returns:

The (immutable) list of all registered parameters.

getOutputs

ProcedureOutputs getOutputs()

Retrieves access to outputs of this procedure call. Can be called multiple times, returning the same ProcedureOutputs instance each time.

If the procedure call has not actually be executed yet, it will be executed and then the ProcedureOutputs will be returned.

Returns:

The ProcedureOutputs representation

extractMemento

ProcedureCallMemento extractMemento(Map<String,Object> hints)

Extract the disconnected representation of this call. Used in HEM to allow redefining a named query

Parameters:

hints - The hints to incorporate into the memento

Returns:

The memento