| FDO API Reference | Feature Data Objects |
00001 #ifndef _ICHANGELONGTRANSACTIONSET_H_ 00002 #define _ICHANGELONGTRANSACTIONSET_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/LongTransaction/LongTransactionSetOperations.h> 00029 #include <Fdo/Commands/ICommand.h> 00030 00031 /// \brief 00032 /// The FdoIChangeLongTransactionSet interface defines the ChangeLongTransactionSet 00033 /// command, which allows the user to add a transaction to, remove a transaction 00034 /// from, or clear the long transaction selection set. Users can add or remove 00035 /// long transactions to the selection set for which they have access 00036 /// privileges. Any attempt to add a long transaction for which the user does 00037 /// not have the access privilege will result in a failure of the command. 00038 class FdoIChangeLongTransactionSet : public FdoICommand 00039 { 00040 friend class FdoIConnection; 00041 00042 public: 00043 /// \brief 00044 /// Gets the name of the long transaction to add or remove from the 00045 /// selection set. 00046 /// 00047 /// \return 00048 /// Returns the name of the long transaction 00049 /// 00050 /// \note 00051 /// This function is not required for the Clear operation. 00052 FDO_API virtual FdoString* GetLongTransactionName() = 0; 00053 00054 /// \brief 00055 /// Sets the name of the long transaction to add or remove from the 00056 /// selection set. 00057 /// 00058 /// \param value 00059 /// Input the name of the long transaction 00060 /// 00061 /// \return 00062 /// Returns nothing 00063 /// 00064 /// \note 00065 /// This function is not required for the Clear operation. 00066 FDO_API virtual void SetLongTransactionName(FdoString* value) = 0; 00067 00068 /// \brief 00069 /// Gets the operation to perform, add, remove, or clear. 00070 /// 00071 /// \return 00072 /// Returns the operation to perform 00073 /// 00074 FDO_API virtual FdoLongTransactionSetOperations GetOperation() = 0; 00075 00076 /// \brief 00077 /// Sets the operation to perform, add, remove, or clear. 00078 /// 00079 /// \param value 00080 /// Input the operation to perform 00081 /// 00082 /// \return 00083 /// Returns nothing 00084 /// 00085 FDO_API virtual void SetOperation(FdoLongTransactionSetOperations value) = 0; 00086 00087 /// \brief 00088 /// Executes the ChangeLongTransactionSet command. 00089 /// 00090 /// \return 00091 /// Returns nothing 00092 /// 00093 FDO_API virtual void Execute() = 0; 00094 }; 00095 #endif 00096 00097
| Comments or suggestions? Send us feedback. |