- Main Page
- Related Pages
- Modules
- Classes
- Files

# IRollbackLongTransactionCheckpoint.h

Go to the documentation of this file.

    00001 #ifndef _IROLLBACKLONGTRANSACTIONCHECKPOINT_H_
    00002 #define _IROLLBACKLONGTRANSACTIONCHECKPOINT_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 #include <Fdo/Commands/ICommand.h>
    00029
    00030 /// \brief
    00031 /// The FdoIRollbackLongTransactionCheckpoint interface defines the
    00032 /// RollbackLongTransactionCheckpoint command, which allows the user to roll back
    00033 /// changes to a named checkpoint for the given long transaction. The user
    00034 /// requires the access privilege on the long transaction for which the user tries
    00035 /// to perform the operation.
    00036 class FdoIRollbackLongTransactionCheckpoint : public FdoICommand
    00037 {
    00038     friend class FdoIConnection;
    00039
    00040 public:
    00041     /// \brief
    00042     /// Gets the name of the long transaction for which a checkpoint should
    00043     /// be rolled back.
    00044     ///
    00045     /// \return
    00046     /// Returns the list of long transaction names.
    00047     ///
    00048     FDO_API virtual FdoString* GetLongTransactionName() = 0;
    00049
    00050     /// \brief
    00051     /// Sets the name of the long transaction for which a checkpoint should
    00052     /// be rolled back.
    00053     ///
    00054     /// \param value
    00055     /// Input the long transaction name.
    00056     ///
    00057     /// \return
    00058     /// Returns nothing
    00059     ///
    00060     FDO_API virtual void SetLongTransactionName(FdoString* value) = 0;
    00061
    00062     /// \brief
    00063     /// Gets the name of the checkpoint to which the rollback operation
    00064     /// should be executed.
    00065     ///
    00066     /// \return
    00067     /// Returns the name of the checkpoint.
    00068     ///
    00069     FDO_API virtual FdoString* GetCheckpointName() = 0;
    00070
    00071     /// \brief
    00072     /// Sets the name of the checkpoint to which the rollback operation
    00073     /// should be executed.
    00074     ///
    00075     /// \param value
    00076     /// Input the name of the checkpoint.
    00077     ///
    00078     /// \return
    00079     /// Returns nothing
    00080     ///
    00081     FDO_API virtual void SetCheckpointName(FdoString* value) = 0;
    00082
    00083     /// \brief
    00084     /// Executes the RollbackLongTransactionCheckpoint command.
    00085     ///
    00086     /// \return
    00087     /// Returns nothing
    00088     ///
    00089     FDO_API virtual void Execute() = 0;
    00090 };
    00091 #endif
    00092
    00093

Please send us your comment about this page