/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2013, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.procedure;

import javax.persistence.ParameterMode;
import javax.persistence.TemporalType;

import org.hibernate.type.Type;

Author:
Steve Ebersole/**
 * @author Steve Ebersole
 */
public interface ParameterRegistration<T> {
	
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;/**
	 * The name under which this parameter was registered.  Can be {@code null} which should indicate that
	 * positional registration was used (and therefore {@link #getPosition()} should return non-null.
	 *
	 * @return The name;
	 */
	public String getName();

	
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;/**
	 * The position at which this parameter was registered.  Can be {@code null} which should indicate that
	 * named registration was used (and therefore {@link #getName()} should return non-null.
	 *
	 * @return The name;
	 */
	public Integer getPosition();

	
Obtain the Java type of parameter. This is used to guess the Hibernate type (unless setHibernateType is called explicitly). 
Returns:
The parameter Java type./**
	 * Obtain the Java type of parameter.  This is used to guess the Hibernate type (unless {@link #setHibernateType}
	 * is called explicitly).
	 *
	 * @return The parameter Java type.
	 */
	public Class<T> getType();

	
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./**
	 * 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).
	 *
	 * @return The parameter mode.
	 */
	public ParameterMode getMode();

	
Set the Hibernate mapping type for this parameter.
Params:
type – The Hibernate mapping type./**
	 * Set the Hibernate mapping type for this parameter.
	 *
	 * @param type The Hibernate mapping type.
	 */
	public void setHibernateType(Type type);

	
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 methods. 
Returns:
The parameter binding/**
	 * Retrieve the binding associated with this parameter.  The binding is only relevant for INPUT parameters.  Can
	 * return {@code null} if nothing has been bound yet.  To bind a value to the parameter use one of the
	 * {@link #bindValue} methods.
	 *
	 * @return The parameter binding
	 */
	public ParameterBind<T> getBind();

	
Bind a value to the parameter.  How this value is bound to the underlying JDBC CallableStatement is
totally dependent on the Hibernate type.
Params:
value – The value to bind./**
	 * Bind a value to the parameter.  How this value is bound to the underlying JDBC CallableStatement is
	 * totally dependent on the Hibernate type.
	 *
	 * @param value The value to bind.
	 */
	public void bindValue(T value);

	
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.
Params:
value – The value to bind
explicitTemporalType – An explicitly supplied TemporalType./**
	 * 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.
	 *
	 * @param value The value to bind
	 * @param explicitTemporalType An explicitly supplied TemporalType.
	 */
	public void bindValue(T value, TemporalType explicitTemporalType);
}