FDO API Reference Feature Data Objects

IGetLongTransactionCheckpoints.h

Go to the documentation of this file.
00001 #ifndef _IGETLONGTRANSACTIONCHECKPOINT_H_
00002 #define _IGETLONGTRANSACTIONCHECKPOINT_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/ILongTransactionCheckpointReader.h>
00029 #include <Fdo/Commands/LongTransaction/LongTransactionConstants.h>
00030 #include <Fdo/Commands/ICommand.h>
00031 
00032 /// \brief
00033 /// The FdoIGetLongTransactionCheckpoints interface defines the
00034 /// GetLongTransactionCheckpoints command, which allows the user to enumerate
00035 /// the checkpoints for a given long transaction. To execute the operation, the
00036 /// user must have access privilege to the long transaction.
00037 class FdoIGetLongTransactionCheckpoints : public FdoICommand
00038 {
00039     friend class FdoIConnection;
00040 
00041 public:
00042     /// \brief
00043     /// Gets the name of the long transaction for which to get the checkpoints.
00044     /// 
00045     /// \return
00046     /// Returns nothing
00047     /// 
00048     FDO_API virtual FdoString* GetLongTransactionName() = 0;
00049 
00050     /// \brief
00051     /// Sets the name of the long transaction for which to get the checkpoints.
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     /// Executes the get long transaction checkpoints command, returning a
00063     /// reference to an FdoILongTransactionCheckpointReader.
00064     /// 
00065     /// \return
00066     /// Returns nothing
00067     /// 
00068     FDO_API virtual FdoILongTransactionCheckpointReader* Execute() = 0;
00069 };
00070 #endif
00071 
00072 

Comments or suggestions? Send us feedback.