FDO .NET API Reference Feature Data Objects

mgILongTransactionSetReaderImp.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\LongTransaction\mgILongTransactionSetReader.h"
00022 
00023 class FdoILongTransactionSetReader;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00026 
00027 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00028 /// \brief
00029 /// The ILongTransactionSetReaderImp class is a concrete implementation of ILongTransactionSetReader.
00030 /// The ILongTransactionSetReader interface provides forward only, read-only
00031 /// functionality for enumerating the versions in the long transaction selection
00032 /// set.  A reference to an ILongTransactionSetReader is returned from the
00033 /// GetLongTransactionsInSet command. The initial position of the
00034 /// ILongTransactionSetReader is prior to the first item. Thus, you must
00035 /// call ReadNext to begin accessing any data.
00036 private __gc class ILongTransactionSetReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionSetReader
00037 {
00038 public:
00039     /// \brief
00040     /// Gets the name of the long transaction in the selection set currently
00041     /// being read.
00042     /// 
00043     /// \return
00044     /// Returns the long transaction name
00045     /// 
00046     System::String* GetLongTransactionName();
00047 
00048     /// \brief
00049     /// Gets the owner of the long transaction in the selection set currently
00050     /// being read.
00051     /// 
00052     /// \return
00053     /// Returns the owner of the long transaction
00054     /// 
00055     System::String* GetOwner();
00056 
00057     /// \brief
00058     /// Advances the reader to the next item. The default position of the
00059     /// reader is prior to the first item. Thus, you must call ReadNext
00060     /// to begin accessing any data.
00061     /// 
00062     /// \return
00063     /// Returns true if there is a next item.
00064     /// 
00065     System::Boolean ReadNext();
00066 
00067     /// \brief
00068     /// Closes the ILongTransactionSetReader object, freeing any resources
00069     /// it may be holding.
00070     /// 
00071     /// \return
00072     /// Returns nothing
00073     /// 
00074     System::Void Close();
00075 
00076 /// \cond DOXYGEN-IGNORE
00077 protected:
00078     System::Void ReleaseUnmanagedObject();
00079 /// \endcond
00080 
00081 public private:
00082     ILongTransactionSetReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
00083     {
00084 
00085     }
00086 
00087     inline FdoILongTransactionSetReader* GetImpObj();
00088 };
00089 
00090 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00091 
00092 

Comments or suggestions? Send us feedback.