org.hibernate.procedure.spi

Interface ParameterRegistrationImplementor<T>

All Superinterfaces:

Parameter<T>, ParameterRegistration<T>, ProcedureParameter<T>, QueryParameter<T>

All Known Subinterfaces:

ProcedureParameterImplementor<T>

All Known Implementing Classes:

ProcedureParameterImpl

public interface ParameterRegistrationImplementor<T>
extends ParameterRegistration<T>

Additional internal contract for ParameterRegistration

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
T	extract(CallableStatement statement) Extract value from the statement after execution (used for OUT/INOUT parameters).
Type	getHibernateType() Access to the Hibernate type for this parameter registration
int[]	getSqlTypes() Access to the SQL type(s) for this parameter
boolean	isPassNullsEnabled() If no value is bound for this parameter registration, is the passing of NULL to the JDBC CallableStatement for that parameter enabled? This effectively controls whether default values for the argument as defined in the database are applied or not.
void	prepare(CallableStatement statement, int i) Prepare for execution.

Methods inherited from interface org.hibernate.procedure.ParameterRegistration

bindValue, bindValue, enablePassingNulls, getBind, getMode, getName, getPosition, getType, setHibernateType

Methods inherited from interface org.hibernate.query.QueryParameter

getSourceLocations

Methods inherited from interface javax.persistence.Parameter

getParameterType

Method Detail

prepare

void prepare(CallableStatement statement,
             int i)
      throws SQLException

Prepare for execution.

Parameters:

statement - The statement about to be executed

i - The parameter index for this registration (used for positional)

Throws:

SQLException - Indicates a problem accessing the statement object

getHibernateType

Type getHibernateType()

Access to the Hibernate type for this parameter registration

Specified by:

getHibernateType in interface QueryParameter<T>

Returns:

The Hibernate Type

isPassNullsEnabled

boolean isPassNullsEnabled()

If no value is bound for this parameter registration, is the passing of NULL to the JDBC CallableStatement for that parameter enabled? This effectively controls whether default values for the argument as defined in the database are applied or not.

Specified by:

isPassNullsEnabled in interface ProcedureParameter<T>

Returns:

true indicates that NULL will be passed to the JDBC driver, effectively disabling the application of the default argument value defined in the database; false indicates that the parameter will simply be ignored, with the assumption that the corresponding argument defined a default value.

See Also:

isPassNullsEnabled()

getSqlTypes

int[] getSqlTypes()

Access to the SQL type(s) for this parameter

Returns:

The SQL types (JDBC type codes)

extract

T extract(CallableStatement statement)

Extract value from the statement after execution (used for OUT/INOUT parameters).

Parameters:

statement - The callable statement

Returns:

The extracted value