org.hibernate.jdbc.Expectation Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2008, Red Hat Middleware LLC 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 Middleware LLC.
*
* 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.jdbc;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import org.hibernate.HibernateException;
/**
* Defines an expected DML operation outcome.
*
* @author Steve Ebersole
*/
public interface Expectation {
/**
* Perform verification of the outcome of the RDBMS operation based on
* the type of expectation defined.
*
* @param rowCount The RDBMS reported "number of rows affected".
* @param statement The statement representing the operation
* @param batchPosition The position in the batch (if batching)
* @throws SQLException Exception from the JDBC driver
* @throws HibernateException Problem processing the outcome.
*/
public void verifyOutcome(int rowCount, PreparedStatement statement, int batchPosition) throws SQLException, HibernateException;
/**
* Perform any special statement preparation.
*
* @param statement The statement to be prepared
* @return The number of bind positions consumed (if any)
* @throws SQLException Exception from the JDBC driver
* @throws HibernateException Problem performing preparation.
*/
public int prepare(PreparedStatement statement) throws SQLException, HibernateException;
/**
* Is it acceptable to combiner this expectation with statement batching?
*
* @return True if batching can be combined with this expectation; false otherwise.
*/
public boolean canBeBatched();
}