Top Description Methods
org.hibernate.procedure.spi

public Interface ParameterRegistrationImplementor<T>

extends ParameterRegistration<T>
Known Direct Subinterfaces
org.hibernate.query.procedure.spi.ProcedureParameterImplementor
Imports
java.sql.CallableStatement, .SQLException, org.hibernate.procedure.ParameterRegistration, org.hibernate.query.QueryParameter, org.hibernate.type.Type
Additional internal contract for ParameterRegistration
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public T

Returns:

The extracted value
extract(CallableStatement
The callable statement
statement)

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

public Type

Returns:

The Hibernate Type
getHibernateType()

Redeclares org.hibernate.query.QueryParameter.getHibernateType.

Access to the Hibernate type for this parameter registration
public int[]

Returns:

The SQL types (JDBC type codes)
getSqlTypes()

Access to the SQL type(s) for this parameter

public boolean

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.
isPassNullsEnabled()

Redeclares org.hibernate.query.procedure.ProcedureParameter.isPassNullsEnabled.

If no value is bound for this parameter registration, is the passing of NULL to the JDBC CallableStatement for that parameter enabled?
public void
prepare(CallableStatement
The statement about to be executed
statement, int
The parameter index for this registration (used for positional)
i)

Prepare for execution.

Inherited from org.hibernate.procedure.ParameterRegistration:
bindValuebindValueenablePassingNullsgetBindgetModegetNamegetPositiongetTypesetHibernateType

Method Detail

extractback to summary
public T extract(CallableStatement statement)

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

Parameters
statement:CallableStatement

The callable statement

Returns:T

The extracted value

getHibernateTypeback to summary
public Type getHibernateType()

Redeclares org.hibernate.query.QueryParameter.getHibernateType.

Access to the Hibernate type for this parameter registration

Returns:Type

The Hibernate Type

Annotations
@Override
getSqlTypesback to summary
public int[] getSqlTypes()

Access to the SQL type(s) for this parameter

Returns:int[]

The SQL types (JDBC type codes)

isPassNullsEnabledback to summary
public boolean isPassNullsEnabled()

Redeclares org.hibernate.query.procedure.ProcedureParameter.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.

Returns:boolean

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.

Annotations
@Override
prepareback to summary
public void prepare(CallableStatement statement, int i) throws SQLException

Prepare for execution.

Parameters
statement:CallableStatement

The statement about to be executed

i:int

The parameter index for this registration (used for positional)

Exceptions
SQLException:
Indicates a problem accessing the statement object