org.hibernate.procedure

Interface ParameterRegistration<T>

All Known Subinterfaces:

ParameterRegistrationImplementor<T>

All Known Implementing Classes:

AbstractParameterRegistrationImpl, NamedParameterRegistration, PositionalParameterRegistration

public interface ParameterRegistration<T>

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
void	bindValue(T value) Bind a value to the parameter.
void	bindValue(T value, TemporalType explicitTemporalType) Bind a value to the parameter, using just a specified portion of the DATE/TIME value.
ParameterBind<T>	getBind() Retrieve the binding associated with this parameter.
ParameterMode	getMode() Retrieves the parameter "mode" which describes how the parameter is defined in the actual database procedure definition (is it an INPUT parameter? An OUTPUT parameter? etc).
String	getName() The name under which this parameter was registered.
Integer	getPosition() The position at which this parameter was registered.
Class<T>	getType() Obtain the Java type of parameter.
void	setHibernateType(Type type) Set the Hibernate mapping type for this parameter.

Method Detail

getName

String getName()

The name under which this parameter was registered. Can be null which should indicate that positional registration was used (and therefore getPosition() should return non-null.

Returns:

The name;

getPosition

Integer getPosition()

The position at which this parameter was registered. Can be null which should indicate that named registration was used (and therefore getName() should return non-null.

Returns:

The name;

getType

Class<T> getType()

Obtain the Java type of parameter. This is used to guess the Hibernate type (unless setHibernateType(org.hibernate.type.Type) is called explicitly).

Returns:

The parameter Java type.

getMode

ParameterMode getMode()

Retrieves the parameter "mode" which describes how the parameter is defined in the actual database procedure definition (is it an INPUT parameter? An OUTPUT parameter? etc).

Returns:

The parameter mode.

setHibernateType

void setHibernateType(Type type)

Set the Hibernate mapping type for this parameter.

Parameters:

type - The Hibernate mapping type.

getBind

ParameterBind<T> getBind()

Retrieve the binding associated with this parameter. The binding is only relevant for INPUT parameters. Can return null if nothing has been bound yet. To bind a value to the parameter use one of the bindValue(T) methods.

Returns:

The parameter binding

bindValue

void bindValue(T value)

Bind a value to the parameter. How this value is bound to the underlying JDBC CallableStatement is totally dependent on the Hibernate type.

Parameters:

value - The value to bind.

bindValue

void bindValue(T value,
               TemporalType explicitTemporalType)

Bind a value to the parameter, using just a specified portion of the DATE/TIME value. It is illegal to call this form if the parameter is not DATE/TIME type. The Hibernate type is circumvented in this case and an appropriate "precision" Type is used instead.

Parameters:

value - The value to bind

explicitTemporalType - An explicitly supplied TemporalType.