FDO .NET API Reference Feature Data Objects

mgIGetLongTransactionsImp.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\mgIGetLongTransactions.h"
00023 
00024 class FdoIGetLongTransactions;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00027 public __gc __interface ILongTransactionReader;
00028 
00029 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00030 /// \brief
00031 /// The IGetLongTransactionsImp class is a concrete implementation of IGetLongTransactions.
00032 /// The IGetLongTransactions interface defines the GetLongTransactions
00033 /// command. It allows a user to retrieve long transaction information for all or
00034 /// a specific long transaction. The command returns a ILongTransactionReader
00035 /// object enumerating the identified long transactions.
00036 private __gc class IGetLongTransactionsImp : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp, 
00037                                              public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::IGetLongTransactions
00038 {
00039 public:
00040     /// \brief
00041     /// Sets the name of the long transaction for which information
00042     /// should be retrieved. The function can also be used to nullify the
00043     /// property by using a NULL pointer as the function's parameter. If the
00044     /// the property is not set, the function returns information for all
00045     /// available long transactions.
00046     /// 
00047     /// \return
00048     /// Returns nothing
00049     /// 
00050     __property System::Void set_Name(System::String* value);
00051 
00052     /// \brief
00053     /// Gets the currently set name of the long transaction for which
00054     /// the long transaction information should be retrieved. If the property
00055     /// is not set, the function returns a NULL pointer.
00056     /// 
00057     /// \return
00058     /// Returns a long transaction name.
00059     /// 
00060     __property System::String* get_Name();
00061 
00062     /// \brief
00063     /// Executes the GetLongTransactions command returning a reference to an
00064     /// ILongTransactionReader.
00065     /// 
00066     /// \return
00067     /// Returns a long transaction reader
00068     /// 
00069     NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionReader* Execute();
00070 
00071 public private:
00072     IGetLongTransactionsImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_FDO_COMMANDS::ICommandImp(unmanaged, autoDelete)
00073     {
00074 
00075     }
00076 
00077     inline FdoIGetLongTransactions* GetImpObj();
00078 };
00079 
00080 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00081 
00082 

Comments or suggestions? Send us feedback.