FDO .NET API Reference Feature Data Objects

mgIChangeLongTransactionSet.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 #include "FDO\Commands\LongTransaction\mgLongTransactionSetOperations.h"
00023 
00024 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00025 
00026 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00027 /// \interface OSGeo::FDO::Commands::LongTransaction::IChangeLongTransactionSet
00028 /// \brief
00029 /// The IChangeLongTransactionSet interface defines the ChangeLongTransactionSet
00030 /// command, which allows the user to add a transaction to, remove a transaction
00031 /// from, or clear the long transaction selection set. Users can add or remove
00032 /// long transactions to the selection set for which they have access
00033 /// privileges. Any attempt to add a long transaction for which the user does
00034 /// not have the access privilege will result in a failure of the command.
00035 public __gc __interface IChangeLongTransactionSet : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00036 {
00037 public:
00038     /// \brief
00039     /// Gets the name of the long transaction to add or remove from the
00040     /// selection set. 
00041     /// 
00042     /// \return
00043     /// Returns the name of the long transaction
00044     /// 
00045     /// Note: This function is not required for the Clear operation.
00046     __property System::String* get_LongTransactionName();
00047 
00048     /// \brief
00049     /// Sets the name of the long transaction to add or remove from the
00050     /// selection set. 
00051     /// 
00052     /// \param value 
00053     /// Input the name of the long transaction
00054     /// 
00055     /// \return
00056     /// Returns nothing
00057     /// 
00058     /// Note: This function is not required for the Clear operation.
00059     __property System::Void set_LongTransactionName(System::String* value);
00060 
00061     /// \brief
00062     /// Gets the operation to perform, add, remove, or clear.
00063     /// 
00064     /// \return
00065     /// Returns the operation to perform
00066     /// 
00067     __property NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::LongTransactionSetOperations get_Operation();
00068 
00069     /// \brief
00070     /// Sets the operation to perform, add, remove, or clear.
00071     /// 
00072     /// \param value 
00073     /// Input the operation to perform
00074     /// 
00075     /// \return
00076     /// Returns nothing
00077     /// 
00078     __property System::Void set_Operation(NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::LongTransactionSetOperations value);
00079 
00080     /// \brief
00081     /// Executes the ChangeLongTransactionSet command.
00082     /// 
00083     /// \return
00084     /// Returns nothing
00085     /// 
00086     System::Void Execute();
00087 };
00088 
00089 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00090 
00091 

Comments or suggestions? Send us feedback.