FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.