Top Description Methods
org.hibernate.query.procedure

public Interface ProcedureParameter<T>

extends QueryParameter<T>
Known Direct Subinterfaces
org.hibernate.query.procedure.spi.ProcedureParameterImplementor, org.hibernate.procedure.ParameterRegistration
Annotations
@Incubating
Imports
javax.persistence.ParameterMode, org.hibernate.Incubating, org.hibernate.procedure.spi.ParameterRegistrationImplementor, org.hibernate.query.QueryParameter

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 TypeMethod and Description
public void
enablePassingNulls(boolean
true indicates that the NULL should be passed; false indicates it should not.
enabled)

Deprecated with no replacement. See org.hibernate.cfg.AvailableSettings#PROCEDURE_NULL_PARAM_PASSING for details
Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution.
public ParameterMode

Returns:

The parameter mode.
getMode()

Retrieves the parameter "mode".

public boolean

Returns:

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

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

Inherited from org.hibernate.query.QueryParameter:
getHibernateTypegetSourceLocations

Method Detail

enablePassingNullsback to summary
public void enablePassingNulls(boolean enabled)

Deprecated

with no replacement. See org.hibernate.cfg.AvailableSettings#PROCEDURE_NULL_PARAM_PASSING for details

Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution. For details see org.hibernate.procedure.ParameterRegistration#enablePassingNulls

Parameters
enabled:boolean

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

Annotations
@Deprecated
See Also
org.hibernate.procedure.ParameterRegistration#enablePassingNulls
getModeback to summary
public 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:ParameterMode

The parameter mode.

isPassNullsEnabledback to summary
public boolean isPassNullsEnabled()

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

Returns:boolean

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

See Also
ParameterRegistrationImplementor#isPassNullsEnabled()