/*
 * HA-JDBC: High-Availability JDBC
 * Copyright (C) 2012  Paul Ferraro
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 program.  If not, see <http://www.gnu.org/licenses/>.
 */
package net.sf.hajdbc.sql;

import java.sql.Connection;
import java.sql.SQLException;

import net.sf.hajdbc.Database;
import net.sf.hajdbc.durability.Durability;
import net.sf.hajdbc.invocation.InvocationStrategy;
import net.sf.hajdbc.invocation.Invoker;

/**
 * Decorates an invocation strategy with transaction boundary logic.
 * @author Paul Ferraro
 * @param <Z>
 * @param <D>
 */
public interface TransactionContext<Z, D extends Database<Z>> extends AutoCloseable
{
	/**
	 * Decorates the specified invocation strategy with start transaction logic.
	 * @param strategy
	 * @param connection
	 * @return the decorated invocation strategy
	 * @throws SQLException
	 */
	InvocationStrategy start(InvocationStrategy strategy, Connection connection) throws SQLException;

	/**
	 * Decorates the specified invoker with start transaction logic.
	 * @param <T>
	 * @param <R>
	 * @param invoker
	 * @param connection
	 * @return the decorated invoker
	 * @throws SQLException
	 */
	<T, R> Invoker<Z, D, T, R, SQLException> start(Invoker<Z, D, T, R, SQLException> invoker, Connection connection) throws SQLException;

	/**
	 * Decorates the specified invocation strategy with end transaction logic.
	 * @param strategy
	 * @param phase
	 * @return the decorated invocation strategy
	 * @throws SQLException
	 */
	InvocationStrategy end(InvocationStrategy strategy, Durability.Phase phase) throws SQLException;

	/**
	 * Decorates the specified invok with end transaction logic.
	 * @param <T>
	 * @param <R>
	 * @param invoker
	 * @param phase
	 * @return the decorated invoker
	 * @throws SQLException
	 */
	<T, R> Invoker<Z, D, T, R, SQLException> end(Invoker<Z, D, T, R, SQLException> invoker, Durability.Phase phase) throws SQLException;
	
	/**
	 * Closes this transaction context.
	 */
	@Override
	void close();
}