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

# IFreezeLongTransaction.h

Go to the documentation of this file.

    00001 #ifndef _IFREEZELONGTRANSACTION_H_
    00002 #define _IFREEZELONGTRANSACTION_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/Commands/ICommand.h>
    00028 #include <Fdo/Commands/LongTransaction/LongTransactionFreezeOperations.h>
    00029
    00030 /// \brief
    00031 /// The FdoIFreezeLongTransaction interface defines the FreezeLongTransaction
    00032 /// command, which freezes or thaws a long transaction. When a long transaction
    00033 /// is frozen the user who froze it gains exclusive access to it. Other users can
    00034 /// read it, but not apply any updates.
    00035 /// Input to the FreezeLongTransaction command is the long transaction name and
    00036 /// the operation to perform. The Execute method performs the specified
    00037 /// operation on the identified long transaction if the user has access
    00038 /// privileges for the indicated long transaction.
    00039 class FdoIFreezeLongTransaction : public FdoICommand
    00040 {
    00041   public:
    00042     /// \brief
    00043     /// Gets the name of the long transaction to freeze or unfreeze as a string.
    00044     ///
    00045     /// \return
    00046     /// Returns the name of the long transaction
    00047     ///
    00048     FDO_API virtual FdoString* GetName() = 0;
    00049
    00050     /// \brief
    00051     /// Sets the name of the long transaction to freeze or unfreeze as a string.
    00052     ///
    00053     /// \param value
    00054     /// Input the name of the long transaction
    00055     ///
    00056     /// \return
    00057     /// Returns nothing
    00058     ///
    00059     FDO_API virtual void SetName(FdoString* value) = 0;
    00060
    00061     /// \brief
    00062     ///  Gets the operation to perform (Freeze or Thaw) on the long transaction.
    00063     ///
    00064     /// \return
    00065     /// Returns the operation to perform
    00066     ///
    00067     FDO_API virtual FdoLongTransactionFreezeOperations GetOperation() = 0;
    00068
    00069     /// \brief
    00070     /// Sets the operation to perform (Freeze or Thaw) on the long transaction.
    00071     ///
    00072     /// \param value
    00073     /// Input the operation to perform
    00074     ///
    00075     /// \return
    00076     /// Returns nothing
    00077     ///
    00078     FDO_API virtual void SetOperation(FdoLongTransactionFreezeOperations value) = 0;
    00079
    00080     /// \brief
    00081     /// Executes the command.
    00082     ///
    00083     /// \return
    00084     /// Returns nothing
    00085     ///
    00086     FDO_API virtual void Execute() = 0;
    00087 };
    00088 #endif
    00089
    00090

Please send us your comment about this page