FDO .NET API Reference Feature Data Objects

mgILockedObjectReader.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\Locking\mgLockType.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS
00024 public __gc class PropertyValueCollection;
00025 END_NAMESPACE_OSGEO_FDO_COMMANDS
00026 
00027 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
00028 
00029 /// \ingroup (OSGeoFDOCommandsLocking)
00030 /// \interface OSGeo::FDO::Commands::Locking::ILockedObjectReader
00031 /// \brief
00032 /// The ILockedObjectReader interface provides forward-only, read-only
00033 /// functionality to identify lock information for a set of objects.
00034 /// \remarks
00035 /// A reference to an ILockedObjectReader interface is returned from the GetLockedObjects
00036 /// and GetLockInfo commands. The initial position of the ILockInfoReader is
00037 /// prior to the first item. Thus, you must call ReadNext to begin accessing
00038 /// any data.
00039 public __gc __interface ILockedObjectReader : public System::IDisposable
00040 {
00041 public:
00042     /// \brief
00043     /// Gets the class name of the feature currently being read.
00044     /// 
00045     /// \remarks
00046     /// The value of the class name will be null in the event that the
00047     /// class name could not be resolved. This can happen if the table has
00048     /// no class id field and multiple classes have been written to the table.
00049     /// 
00050     /// \return
00051     /// Returns the name of the class.
00052     /// 
00053     System::String* GetFeatureClassName();
00054 
00055     /// \brief
00056     /// Gets an PropertyValueCollection containing the property values
00057     /// that uniquely identify the feature currently being read.
00058     /// 
00059     /// \return
00060     /// Returns the property collection identifying the feature.
00061     /// 
00062     NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValueCollection* GetIdentity();
00063 
00064     /// \brief
00065     /// Gets the name of user who holds the lock on the feature currently being
00066     /// read.
00067     /// 
00068     /// \return
00069     /// Returns the lock owner
00070     /// 
00071     System::String* GetLockOwner();
00072 
00073     /// \brief
00074     /// Gets the type of the lock held on the feature currently being read.
00075     /// 
00076     /// \return
00077     /// Returns the lock type
00078     /// 
00079     NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockType GetLockType();
00080 
00081     /// \brief
00082     /// Gets the name of the long transaction in which the feature 
00083     /// currently being read is locked.
00084     /// 
00085     /// \return
00086     /// Returns the name of the long transaction in which the feature
00087     /// currently being read is locked.
00088     /// 
00089     System::String* GetLongTransaction();
00090 
00091     /// \brief
00092     /// Advances the reader to the next item. The default position of the 
00093     /// reader is prior to the first item. Thus, you must call ReadNext
00094     /// to begin accessing any data.
00095     /// 
00096     /// \return
00097     /// Returns true if there is a next item.
00098     /// 
00099     System::Boolean ReadNext();
00100 
00101     /// \brief
00102     /// Closes the ILockInfoReader object, freeing any resources it may
00103     /// be holding.
00104     /// 
00105     /// \return
00106     /// Returns nothing
00107     /// 
00108     System::Void Close();
00109 };
00110 
00111 END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
00112 
00113 

Comments or suggestions? Send us feedback.