001    /*
002     * ============================================================================
003     * GNU Lesser General Public License
004     * ============================================================================
005     *
006     * Beanlet - JSE Application Container.
007     * Copyright (C) 2006  Leon van Zantvoort
008     * 
009     * This library is free software; you can redistribute it and/or
010     * modify it under the terms of the GNU Lesser General Public
011     * License as published by the Free Software Foundation; either
012     * version 2.1 of the License, or (at your option) any later version.
013     * 
014     * This library is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
017     * Lesser General Public License for more details.
018     * 
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this library; if not, write to the Free Software
021     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
022     * 
023     * Leon van Zantvoort
024     * 243 Acalanes Drive #11
025     * Sunnyvale, CA 94086
026     * USA
027     *
028     * zantvoort@users.sourceforge.net
029     * http://beanlet.org
030     */
031    package org.beanlet.transaction;
032    
033    import javax.transaction.UserTransaction;
034    import org.beanlet.BeanletStateException;
035    
036    /**
037     * Provides access to the transaction runtime context of the beanlet instance.
038     *
039     * @author Leon van Zantvoort
040     */
041    public interface TransactionContext {
042        
043        /**
044         * Mark the current transaction for rollback.
045         *
046         * @throws BeanletStateException if the current thread is not associated 
047         * with a transaction.
048         */
049        void setRollbackOnly() throws BeanletStateException;
050        
051        /**
052         * Test if the transaction has been marked for rollback only.
053         * @return <code>true</code> if the transaction has been marked for rollback only.
054         * @throws BeanletStateException if the current thread is not associated
055         * with a transaction.
056         */
057        boolean getRollbackOnly() throws BeanletStateException;
058        
059        /**
060         * Obtain the transaction demarcation interface.
061         * @throws BeanletStateException if no user transaction has been installed.
062         */
063        UserTransaction getUserTransaction() throws BeanletStateException;
064    }