FDO .NET API Reference Feature Data Objects

mgIActivateLongTransactionCheckpoint.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\mgICommand.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00024 
00025 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00026 /// \interface OSGeo::FDO::Commands::LongTransaction::IActivateLongTransactionCheckpoint
00027 /// \brief
00028 /// The IActivateLongTransactionCheckpoint interface defines the
00029 /// ActivateLongTransactionCheckpoint command, which allows the user to
00030 /// activate the named checkpoint for the given long transaction. As a result, 
00031 /// the long transaction that owns the checkpoint will be activated as well if
00032 /// it is not already the active long transaction. The user requires the access
00033 /// privilege on the long transaction for which the attempt is made to activate a
00034 /// checkpoint.
00035 public __gc __interface IActivateLongTransactionCheckpoint : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00036 {
00037 public:
00038     /// \brief
00039     /// Gets the name of the checkpoint to be activated for the named long
00040     /// transaction. If the property's value is empty the system will
00041     /// activate the most recent checkpoint of the long transaction.
00042     /// 
00043     /// \return
00044     /// Returns nothing
00045     /// 
00046     __property System::String* get_CheckpointName();
00047 
00048     /// \brief
00049     /// Sets the name of the checkpoint to be activated for the named long
00050     /// transaction. If the property's value is empty the system will
00051     /// activate the most recent checkpoint of the long transaction.
00052     /// 
00053     /// \param value 
00054     /// Input the name of the checkpoint
00055     /// 
00056     /// \return
00057     /// Returns nothing
00058     /// 
00059     __property System::Void set_CheckpointName(System::String* value);
00060 
00061     /// \brief
00062     /// Executes the ActivateLongTransactionCheckpoint command.
00063     /// 
00064     /// \return
00065     /// Returns nothing
00066     /// 
00067     System::Void Execute();
00068 };
00069 
00070 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00071 
00072 

Comments or suggestions? Send us feedback.