/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2011, 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.engine.jdbc.batch.spi;

import org.hibernate.jdbc.Expectation;

Unique key for batch identification.
Author:
Steve Ebersole/**
 * Unique key for batch identification.
 *
 * @author Steve Ebersole
 */
public interface BatchKey {
	
How many statements will be in this batch?

Note that this is distinctly different than the size of the batch.
Returns:
The number of statements./**
	 * How many statements will be in this batch?
	 * <p/>
	 * Note that this is distinctly different than the size of the batch.
	 *
	 * @return The number of statements.
	 */
	public int getBatchedStatementCount();

	
Get the expectation pertaining to the outcome of the Batch associated with this key. 
Returns:
The expectations/**
	 * Get the expectation pertaining to the outcome of the {@link Batch} associated with this key.
	 *
	 * @return The expectations
	 */
	public Expectation getExpectation();
}