FDO API Reference Feature Data Objects

ITransaction.h

Go to the documentation of this file.
00001 #ifndef _ITRANSACTION_H_
00002 #define _ITRANSACTION_H_
00003 //
00004 
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 #include <FdoStd.h>
00027 #include <Fdo/Connections/IConnection.h>
00028 
00029 class FdoIConnection;
00030 
00031 /// \brief
00032 ///  The FdoITransaction interface represents a transaction to be performed in a DataStore, and is implemented
00033 /// by feature providers that support transactions.
00034 class FdoITransaction : public FdoIDisposable
00035 {
00036 public:
00037     /// \brief
00038     ///  Gets the FdoIConnection object associated with the transaction.
00039     /// 
00040     /// \return
00041     /// Returns FdoIConnection object
00042     /// 
00043     FDO_API virtual FdoIConnection* GetConnection() = 0;
00044 
00045     /// \brief
00046     ///  Commits the transaction.
00047     /// 
00048     /// \return
00049     /// Returns nothing
00050     /// 
00051     FDO_API virtual void Commit() = 0;
00052 
00053     /// \brief
00054     ///  Rolls back a transaction from a pending state.
00055     /// 
00056     /// \return
00057     /// Returns nothing
00058     /// 
00059     FDO_API virtual void Rollback() = 0;
00060 };
00061 #endif
00062 
00063 

Comments or suggestions? Send us feedback.