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

# IActivateLongTransactionCheckpoint.h

Go to the documentation of this file.

    00001 #ifndef _IACTIVATELONGTRANSACTIONCHECKPOINT_H_
    00002 #define _IACTIVATELONGTRANSACTIONCHECKPOINT_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 FdoIActivateLongTransactionCheckpoint interface defines the
    00032 /// IActivateLongTransactionCheckpoint command, which allows the user to
    00033 /// activate the named checkpoint for the given long transaction. As a result,
    00034 /// the long transaction that owns the checkpoint will be activated as well if
    00035 /// it is not already the active long transaction. The user requires the access
    00036 /// privilege on the long transaction for which the attempt is made to activate a
    00037 /// checkpoint.
    00038 class FdoIActivateLongTransactionCheckpoint : public FdoICommand
    00039 {
    00040     friend class FdoIConnection;
    00041
    00042 public:
    00043     /// \brief
    00044     /// Gets the name of the checkpoint to be activated for the named long
    00045     /// transaction. If the property's value is empty the system will
    00046     /// activate the most recent checkpoint of the long transaction.
    00047     ///
    00048     /// \return
    00049     /// Returns nothing
    00050     ///
    00051     FDO_API virtual FdoString* GetCheckpointName() = 0;
    00052
    00053     /// \brief
    00054     /// Sets the name of the checkpoint to be activated for the named long
    00055     /// transaction. If the property's value is empty the system will
    00056     /// activate the most recent checkpoint of the long transaction.
    00057     ///
    00058     /// \param value
    00059     /// Input the name of the checkpoint
    00060     ///
    00061     /// \return
    00062     /// Returns nothing
    00063     ///
    00064     FDO_API virtual void SetCheckpointName(FdoString* value) = 0;
    00065
    00066     /// \brief
    00067     /// Executes the ActivateLongTransactionCheckpoint command.
    00068     ///
    00069     /// \return
    00070     /// Returns nothing
    00071     ///
    00072     FDO_API virtual void Execute() = 0;
    00073 };
    00074 #endif
    00075
    00076

Please send us your comment about this page