org.hibernate.engine.jdbc.cursor.spi.RefCursorSupport Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.engine.jdbc.cursor.spi;
import java.sql.CallableStatement;
import java.sql.ResultSet;
import org.hibernate.service.Service;
/**
* Contract for JDBC REF_CURSOR support.
*
* @author Steve Ebersole
*
* @since 4.3
*/
public interface RefCursorSupport extends Service {
/**
* Register a parameter capable of returning a {@link java.sql.ResultSet} *by position*.
*
* @param statement The callable statement.
* @param position The bind position at which to register the output param.
*/
public void registerRefCursorParameter(CallableStatement statement, int position);
/**
* Register a parameter capable of returning a {@link java.sql.ResultSet} *by name*.
*
* @param statement The callable statement.
* @param name The parameter name (for drivers which support named parameters).
*/
public void registerRefCursorParameter(CallableStatement statement, String name);
/**
* Given a callable statement previously processed by {@link #registerRefCursorParameter(java.sql.CallableStatement, int)},
* extract the {@link java.sql.ResultSet}.
*
*
* @param statement The callable statement.
* @param position The bind position at which to register the output param.
*
* @return The extracted result set.
*/
public ResultSet getResultSet(CallableStatement statement, int position);
/**
* Given a callable statement previously processed by {@link #registerRefCursorParameter(java.sql.CallableStatement, String)},
* extract the {@link java.sql.ResultSet}.
*
* @param statement The callable statement.
* @param name The parameter name (for drivers which support named parameters).
*
* @return The extracted result set.
*/
public ResultSet getResultSet(CallableStatement statement, String name);
}