FDO .NET API Reference Feature Data Objects

mgIRollbackLongTransaction.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\mgIFeatureCommand.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00024 
00025 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00026 /// \interface OSGeo::FDO::Commands::LongTransaction::IRollbackLongTransaction
00027 /// \brief
00028 /// The IRollbackLongTransaction interface defines the RollbackLongTransaction
00029 /// command, which allows a user to execute rollback operations on a long
00030 /// transaction. Two different rollback operations are distinguished: full and partial.
00031 ///
00032 /// <ol>
00033 /// <li> A full rollback operation is executed on all data within a long transaction and all its descendents. The data is removed from the database and all versions involved in the process deleted.
00034 /// <li> A partial rollback operation is executed on a subset of the data within a long transaction (which could be all data). The specified data in this long transaction and all its descendents are removed from the database. The versions involved in the process are not removed. The subset of the data to be rolled back is defined by a class name and a set of filter criteria.
00035 /// </ol>
00036 ///
00037 /// To perform a rollback operation, the user requires the access and
00038 /// rollback privileges for the long transaction to be rolled back (in the case
00039 /// of a full rollback, the user also requires the remove privilege for the
00040 /// long transaction) and the access privilege for all the descendent
00041 /// versions.
00042 public __gc __interface IRollbackLongTransaction : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommand
00043 {
00044 public:
00045     /// \brief
00046     /// Gets the name of the long transaction to roll back as a string.
00047     /// 
00048     /// \return
00049     /// Returns the name of the long transaction.
00050     /// 
00051     __property System::String* get_Name();
00052 
00053     /// \brief
00054     /// Sets the name of the long transaction to roll back as a string.
00055     /// 
00056     /// \param value 
00057     /// Input the name of the long transaction.
00058     /// 
00059     /// \return
00060     /// Returns nothing
00061     /// 
00062     __property System::Void set_Name(System::String* value);
00063 
00064     /// \brief
00065     /// Executes the RollbackLongTransaction command.
00066     /// 
00067     /// \return
00068     /// Returns nothing
00069     /// 
00070     System::Void Execute();
00071 };
00072 
00073 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00074 
00075 

Comments or suggestions? Send us feedback.