org.hibernate.query.procedure

Interface ProcedureParameter<T>

All Superinterfaces:

Parameter<T>, QueryParameter<T>

All Known Subinterfaces:

ParameterRegistration<T>, ParameterRegistrationImplementor<T>, ProcedureParameterImplementor<T>

All Known Implementing Classes:

ProcedureParameterImpl

public interface ProcedureParameter<T>
extends QueryParameter<T>

NOTE: Consider this contract (and its sub-contracts) as incubating as we transition to 6.0 and SQM

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
void	enablePassingNulls(boolean enabled) Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution.
ParameterMode	getMode() Retrieves the parameter "mode".
boolean	isPassNullsEnabled() How will an unbound value be handled in terms of the JDBC parameter?

Methods inherited from interface org.hibernate.query.QueryParameter

getHibernateType, getSourceLocations

Methods inherited from interface javax.persistence.Parameter

getName, getParameterType, getPosition

Method Detail

getMode

ParameterMode getMode()

Retrieves the parameter "mode". Only really pertinent in regards to procedure/function calls. In all other cases the mode would be ParameterMode.IN

Returns:

The parameter mode.

isPassNullsEnabled

boolean isPassNullsEnabled()

How will an unbound value be handled in terms of the JDBC parameter?

Returns:

true here indicates that NULL should be passed; false indicates that it is ignored.

See Also:

ParameterRegistrationImplementor.isPassNullsEnabled()

enablePassingNulls

void enablePassingNulls(boolean enabled)

Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution. For details see ParameterRegistration.enablePassingNulls(boolean)

Parameters:

enabled - true indicates that the NULL should be passed; false indicates it should not.

See Also:

ParameterRegistration.enablePassingNulls(boolean)