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

# IActivateLongTransaction.h

Go to the documentation of this file.

    00001 #ifndef _IACTIVATELONGTRANSACTION_H_
    00002 #define _IACTIVATELONGTRANSACTION_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/LongTransaction/LongTransactionConstants.h>
    00028 #include <Fdo/Connections/IConnection.h>
    00029 #include <Fdo/Commands/ICommand.h>
    00030
    00031 /// \brief
    00032 /// The FdoIActivateLongTransaction interface defines the ActivateLongTransaction
    00033 /// command, which activates a long transaction where feature manipulation and
    00034 /// locking commands operate on it. Input to the activate
    00035 /// long transaction command is the long transaction name. The Execute operation
    00036 /// activates the identified long transaction if the user has access privileges
    00037 /// for it.
    00038 class FdoIActivateLongTransaction : public FdoICommand
    00039 {
    00040     friend class FdoIConnection;
    00041
    00042 public:
    00043     /// \brief
    00044     /// Gets the name of the long transaction to activate as a string.
    00045     ///
    00046     /// \return
    00047     /// Returns the name of the long transaction
    00048     ///
    00049     FDO_API virtual FdoString* GetName() = 0;
    00050
    00051     /// \brief
    00052     /// Sets the name of the long transaction to activate as a string.
    00053     ///
    00054     /// \param value
    00055     /// Input the name of the long transaction
    00056     ///
    00057     /// \return
    00058     /// Returns nothing
    00059     ///
    00060     FDO_API virtual void SetName(FdoString* value) = 0;
    00061
    00062     /// \brief
    00063     /// Executes the activate long transaction command. An exception is
    00064     /// thrown if the long transaction does not exist or the user does not
    00065     /// have access privileges to the long transaction.
    00066     ///
    00067     /// \return
    00068     /// Returns nothing
    00069     ///
    00070     FDO_API virtual void Execute() = 0;
    00071 };
    00072 #endif
    00073
    00074

Please send us your comment about this page