/*
 * Copyright 2012 International Business Machines Corp.
 * 
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. Licensed under the Apache License, 
 * Version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
*/
package org.apache.batchee.spi;

/**
 * We have this interface so that we do not try to load the
 * Java EE UserTransaction in an SE environment
 */
public interface TransactionManagerAdapter {
    /**
     * Create a new transaction and associate it with
     * the current thread.
     */
    public void begin();

    /**
     * Complete the transaction associated with the
     * current thread.
     */
    public void commit();

    /**
     * Obtain the status of the transaction associated
     * with the current thread.
     *
     * @return The transaction status.
     */
    public int getStatus();

    /**
     * Roll back the transaction associated with the
     * current thread. When this method completes,
     * the thread becomes associated with no transaction.
     *
     * Attention: this must not throw an Exception until there is a setup problem!
     * So if the tx is not active anymore and we get an Exception while trying
     * to rollback then it MUST get catched away. Otoh if there is a setup
     * or system issue the Exception from the rollback needs to get thrown.
     */
    public void rollback();

    /**
     * Modify the transaction associated with the current
     * thread such that the only possible outcome of the
     * transaction is to roll back the transaction.
     */
    public void setRollbackOnly();

    /**
     * Modify the value of the timeout value that is
     * associated with the transactions started by the
     * current thread with the begin method.
     *
     * @param arg0 seconds - The value of the timeout
     *             in seconds. If the value is zero, the transaction
     *             service restores the default value.
     */
    public void setTransactionTimeout(int arg0);

}