FDO .NET API Reference Feature Data Objects

mgIActivateLTCheckpointImp.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 #include "FDO\Commands\LongTransaction\mgIActivateLongTransactionCheckpoint.h"
00022 #include "FDO\Commands\mgICommandImp.h"
00023 
00024 class FdoIActivateLongTransactionCheckpoint;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00027 
00028 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00029 /// \brief
00030 /// The IActivateLongTransactionCheckpointImp class is a 
00031 /// concrete implementation of IActivateLongTransactionCheckpoint.
00032 /// The IActivateLongTransactionCheckpoint interface defines the
00033 /// IActivateLongTransactionCheckpointImp command, which allows the user to
00034 /// activate the named checkpoint for the given long transaction. As a result, 
00035 /// the long transaction that owns the checkpoint will be activated as well if
00036 /// it is not already the active long transaction. The user requires the access
00037 /// privilege on the long transaction for which the attempt is made to activate a
00038 /// checkpoint.
00039 private __gc class IActivateLongTransactionCheckpointImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, 
00040                                                            public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IActivateLongTransactionCheckpoint
00041 {
00042 public:
00043     /// \brief
00044     /// Gets the name of the checkpoint to be activated for the named long
00045     /// transaction. If the property's value is empty the system will
00046     /// activate the most recent checkpoint of the long transaction.
00047     /// 
00048     /// \return
00049     /// Returns nothing
00050     /// 
00051     __property System::String* get_CheckpointName();
00052 
00053     /// \brief
00054     /// Sets the name of the checkpoint to be activated for the named long
00055     /// transaction. If the property's value is empty the system will
00056     /// activate the most recent checkpoint of the long transaction.
00057     /// 
00058     /// \param value 
00059     /// Input the name of the checkpoint
00060     /// 
00061     /// \return
00062     /// Returns nothing
00063     /// 
00064     __property System::Void set_CheckpointName(System::String* value);
00065 
00066     /// \brief
00067     /// Executes the ActivateLongTransactionCheckpoint command.
00068     /// 
00069     /// \return
00070     /// Returns nothing
00071     /// 
00072     System::Void Execute();
00073 
00074 public private:
00075     IActivateLongTransactionCheckpointImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp(unmanaged, autoDelete)
00076     {
00077 
00078     }
00079 
00080     inline FdoIActivateLongTransactionCheckpoint* GetImpObj();
00081 };
00082 
00083 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00084 
00085 

Comments or suggestions? Send us feedback.