| FDO API Reference | Feature Data Objects |
00001 #ifndef _ICREATELONGTRANSACTIONCHECKPOINT_H_ 00002 #define _ICREATELONGTRANSACTIONCHECKPOINT_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 #include <Fdo/Commands/LongTransaction/LongTransactionConstants.h> 00030 00031 /// \brief 00032 /// The FdoICreateLongTransactionCheckpoint interface defines the 00033 /// CreateLongTransactionCheckpoint command, which allows the user to create a 00034 /// checkpoint for any long transaction to which the user has the access privileges. 00035 class FdoICreateLongTransactionCheckpoint : public FdoICommand 00036 { 00037 friend class FdoIConnection; 00038 00039 public: 00040 /// \brief 00041 /// Gets the name of the long transaction for which a checkpoint should 00042 /// be created. 00043 /// 00044 /// \return 00045 /// Returns the long transaction name 00046 /// 00047 FDO_API virtual FdoString* GetLongTransactionName() = 0; 00048 00049 /// \brief 00050 /// Sets the name of the long transaction for which a checkpoint should 00051 /// be created. 00052 /// 00053 /// \param value 00054 /// Input the name of the long transaction 00055 /// 00056 /// \return 00057 /// Returns nothing 00058 /// 00059 FDO_API virtual void SetLongTransactionName(FdoString* value) = 0; 00060 00061 /// \brief 00062 /// Gets the name of the checkpoint to be created for the named long 00063 /// transaction. 00064 /// 00065 /// \return 00066 /// Returns the checkpoint name 00067 /// 00068 FDO_API virtual FdoString* GetCheckpointName() = 0; 00069 00070 /// \brief 00071 /// Sets the name of the checkpoint to be created for the named long 00072 /// transaction. 00073 /// 00074 /// \param value 00075 /// Input the checkpoint name 00076 /// 00077 /// \return 00078 /// Returns nothing 00079 /// 00080 FDO_API virtual void SetCheckpointName(FdoString* value) = 0; 00081 00082 /// \brief 00083 /// Gets the description of the checkpoint to be created for the named 00084 /// long transaction. 00085 /// 00086 /// \return 00087 /// Returns the description of the checkpoint 00088 /// 00089 FDO_API virtual FdoString* GetCheckpointDescription() = 0; 00090 00091 /// \brief 00092 /// Sets the description of the checkpoint to be created for the named 00093 /// long transaction. 00094 /// 00095 /// \param value 00096 /// Input the description of the checkpoint 00097 /// 00098 /// \return 00099 /// Returns nothing 00100 /// 00101 FDO_API virtual void SetCheckpointDescription(FdoString* value) = 0; 00102 00103 /// \brief 00104 /// Executes the CreateLongTransactionCheckpoint command. 00105 /// 00106 /// \return 00107 /// Returns nothing 00108 /// 00109 FDO_API virtual void Execute() = 0; 00110 }; 00111 #endif 00112 00113
| Comments or suggestions? Send us feedback. |