ParameterRegistration (Hibernate JavaDocs)

All Known Subinterfaces:

ParameterRegistrationImplementor<T>

All Known Implementing Classes:

AbstractParameterRegistrationImpl, NamedParameterRegistration, PositionalParameterRegistration
```
public interface ParameterRegistration<T>
```
Describes a registered procedure/function parameter.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`bindValue(T value)` Bind a value to the parameter.
`void`	`bindValue(T value, javax.persistence.TemporalType explicitTemporalType)` Bind a value to the parameter, using just a specified portion of the DATE/TIME value.
`void`	`enablePassingNulls(boolean enabled)` Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution.
`ParameterBind<T>`	`getBind()` Retrieve the binding associated with this parameter.
`javax.persistence.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).
`java.lang.String`	`getName()` The name under which this parameter was registered.
`java.lang.Integer`	`getPosition()` The position at which this parameter was registered.
`java.lang.Class<T>`	`getType()` Obtain the Java type of parameter.
`void`	`setHibernateType(Type type)` Set the Hibernate mapping type for this parameter.

- Method Detail
  - getName
```
java.lang.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
```
java.lang.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
```
java.lang.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
```
javax.persistence.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.
  - enablePassingNulls
```
void enablePassingNulls(boolean enabled)
```
    Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution. There are 2 possible options to handle it:
    - bind the NULL to the parameter
    - do not bind the NULL to the parameter
    The reason for the distinction comes from default values defined on the corresponding database procedure/function argument. Any time a value (including NULL) is bound to the argument, its default value will not be used. So effectively this setting controls whether the NULL should be interpreted as "pass the NULL" or as "apply the argument default".
    The (global) default this setting is defined by AvailableSettings.PROCEDURE_NULL_PARAM_PASSING
    Parameters:
    
    enabled - true indicates that the NULL should be passed; false indicates it should not.
  - 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,
               javax.persistence.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.

Interface ParameterRegistration<T>

Method Summary

Method Detail

getName

getPosition

getType

getMode

enablePassingNulls

setHibernateType

getBind

bindValue

bindValue