FDO .NET API Reference Feature Data Objects

mgIActivateLongTransaction.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::IActivateLongTransaction
00027 /// \brief
00028 /// The IActivateLongTransaction interface defines the ActivateLongTransaction
00029 /// command, which activates a long transaction where feature manipulation and
00030 /// locking commands operate on it. Input to the activate
00031 /// long transaction command is the long transaction name. The Execute operation
00032 /// activates the identified long transaction if the user has access privileges
00033 /// for it.
00034 public __gc __interface IActivateLongTransaction : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00035 {
00036 public:
00037     /// \brief
00038     /// Gets the name of the long transaction to activate as a string.
00039     /// 
00040     /// \return
00041     /// Returns the name of the long transaction
00042     /// 
00043     __property System::String* get_Name();
00044 
00045     /// \brief
00046     /// Sets the name of the long transaction to activate as a string.
00047     /// 
00048     /// \param value 
00049     /// Input the name of the long transaction
00050     /// 
00051     /// \return
00052     /// Returns nothing
00053     /// 
00054     __property System::Void set_Name(System::String* value);
00055 
00056     /// \brief
00057     /// Executes the activate long transaction command. An exception is
00058     /// thrown if the long transaction does not exist or the user does not
00059     /// have access privileges to the long transaction.
00060     /// 
00061     /// \return
00062     /// Returns nothing
00063     /// 
00064     System::Void Execute();
00065 };
00066 
00067 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00068 
00069 

Comments or suggestions? Send us feedback.