/***************************************************************************
                          SIMPLY POWERFUL TOOLKIT (SPTK)
                          CTransaction.h  -  description
                             -------------------
    begin                : Mon Apr 17 2000
    copyright            : (C) 2000-2005 by Alexey S.Parshin
    email                : alexeyp@gmail.com
 ***************************************************************************/

/***************************************************************************
   This library is free software; you can redistribute it and/or modify it 
   under the terms of the GNU Library General Public License as published by
   the Free Software Foundation; either version 2 of the License, or (at 
   your option) any later version.

   This library 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 Library
   General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; if not, write to the Free Software Foundation, 
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

   Please report all bugs and problems to "alexeyp@gmail.com"
 ***************************************************************************/

#ifndef __CTRANSACTION_H__
#define __CTRANSACTION_H__

#include <sptk3/CDatabase.h>
#include <sptk3/CException.h>

/// @addtogroup Database Database Support
/// @{

/// @brief Database Transaction.
///
/// Allows to begin, commit, and rollback the transaction automatically.
/// If the transaction object is deleted w/o commiting or rolling back
/// the transaction, it rolls back the transaction (if active)
class CTransaction {
   bool         m_active;   ///< Transaction activity
   CDatabase   *m_db;       ///< Database to work with
public:
   /// Constructor
   /// @param db CDatabase&, the database to work with
   CTransaction(CDatabase& db);

   /// Destructor
   ~CTransaction();

   /// Begins the transaction
   void begin();

   /// Commits the transaction
   void commit();

   /// Rolls back the transaction
   void rollback();

   /// Is transaction active?
   bool active() const { return m_active; }
};

/// @}

#endif
