FDO .NET API Reference | Feature Data Objects |
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\mgConflictType.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::ILockConflictReader 00031 /// \brief 00032 /// The ILockConflictReader interface provides forward only, read-only 00033 /// functionality for identifying features that have a lock conflict. 00034 /// Features with a lock conflict are those that the caller is attempting to modify 00035 /// that are already locked by someone else. 00036 /// \remarks 00037 /// A reference to an ILockConflictReader is returned from the 00038 /// AcquireLock, Select, ReleaseLock, Update, and Delete commands. The 00039 /// initial position of the ILockConflictReader is prior to the first item, 00040 /// thus you must call ReadNext to begin accessing any data. 00041 public __gc __interface ILockConflictReader : public System::IDisposable 00042 { 00043 public: 00044 /// \brief 00045 /// Gets the class name of the feature currently being read. 00046 /// 00047 /// \remarks 00048 /// The value of the class name will be null in the event that the class 00049 /// name could not be resolved. This can happen 00050 /// if the table has no class id field and multiple classes have been 00051 /// written to the table. 00052 /// 00053 /// \return 00054 /// Returns the class name. 00055 /// 00056 System::String* GetFeatureClassName(); 00057 00058 /// \brief 00059 /// Returns an PropertyValueCollection containing the property values 00060 /// that uniquely identify the feature currently being read. 00061 /// 00062 /// \return 00063 /// Returns the property collection identifying the feature. 00064 /// 00065 NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValueCollection* GetIdentity(); 00066 00067 /// \brief 00068 /// Gets the name of the owner who holds a lock on the feature 00069 /// currently being read. 00070 /// 00071 /// \return 00072 /// Returns the name of the owner 00073 /// 00074 System::String* GetLockOwner(); 00075 00076 /// \brief 00077 /// Gets the name of the long transaction in which the feature 00078 /// currently being read is locked. 00079 /// 00080 /// \return 00081 /// Returns the name of the long transaction in which the feature 00082 /// currently being read is locked. 00083 /// 00084 System::String* GetLongTransaction(); 00085 00086 /// \brief 00087 /// Gets the conflict type for the conflict currently being read. 00088 /// 00089 /// \return 00090 /// Returns the conflict type for the conflict currently being read. 00091 /// 00092 NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ConflictType GetConflictType(); 00093 00094 /// \brief 00095 /// Advances the reader to the next item. The default position of the 00096 /// reader is prior to the first item. Thus, you must call ReadNext 00097 /// to begin accessing any data. 00098 /// 00099 /// \return 00100 /// Returns true if there is a next item. 00101 /// 00102 System::Boolean ReadNext(); 00103 00104 /// \brief 00105 /// Closes the ILockConflictReader object, freeing any resources it may 00106 /// be holding. 00107 /// 00108 /// \return 00109 /// Returns nothing 00110 /// 00111 System::Void Close(); 00112 }; 00113 00114 END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING 00115 00116
Comments or suggestions? Send us feedback. |