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\Feature\mgIBaseSelect.h" 00022 #include "FDO\Commands\Locking\mgLockType.h" 00023 #include "FDO\Commands\Locking\mgLockStrategy.h" 00024 00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING 00026 public __gc __interface ILockConflictReader; 00027 END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING 00028 00029 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE 00030 public __gc __interface IFeatureReader; 00031 00032 /// \ingroup (OSGeoFDOCommandsFeature) 00033 /// \interface OSGeo::FDO::Commands::Feature::ISelect 00034 /// \brief 00035 /// The ISelect interface defines the Select command, which queries for features 00036 /// of a given class that match the specified criteria. Input to the select 00037 /// command includes the name of the class, the list of properties to be 00038 /// returned, and a filter. All but the class name is optional. If the list of 00039 /// properties to be returned is empty then all properties are returned. The 00040 /// filter may be specified either as text or as an expression tree (most likely 00041 /// produced by a query builder). The result of executing a select command is an 00042 /// IFeatureReader reference (see "Reading Features"). If the feature provider 00043 /// supports locking, then the select command can optionally lock all of the 00044 /// features selected, via the ExecuteWithLock method (see "Locking 00045 /// Commands" for more information on locking features). 00046 public __gc __interface ISelect : public NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IBaseSelect 00047 { 00048 public: 00049 /// \brief 00050 /// Gets the LockType value (see "Locking Commands"). 00051 /// 00052 /// \return 00053 /// Returns the lock type. 00054 /// 00055 __property NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockType get_LockType(); 00056 00057 /// \brief 00058 /// Sets the LockType value (see "Locking Commands"). 00059 /// 00060 /// \param value 00061 /// Input the lock type. 00062 /// 00063 /// \return 00064 /// Returns nothing 00065 /// 00066 __property System::Void set_LockType(NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockType value); 00067 00068 /// \brief 00069 /// Gets the LockStrategy value (see "Locking Commands"). 00070 /// 00071 /// \return 00072 /// Returns the lock strategy. 00073 /// 00074 __property NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockStrategy get_LockStrategy(); 00075 00076 /// \brief 00077 /// Sets the LockStrategy value (see "Locking Commands"). 00078 /// 00079 /// \param value 00080 /// Input the lock strategy. 00081 /// 00082 /// \return 00083 /// Returns nothing 00084 /// 00085 __property System::Void set_LockStrategy(NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockStrategy value); 00086 00087 /// \brief 00088 /// Executes the select command and returns a reference to an IFeatureReader. 00089 /// 00090 /// \return 00091 /// Returns the feature reader. 00092 /// 00093 NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* Execute(); 00094 00095 /// \brief 00096 /// Executes the select command and returns a reference to an 00097 /// IFeatureReader. 00098 /// 00099 /// \return 00100 /// Returns the feature reader. 00101 /// 00102 NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* ExecuteWithLock(); 00103 00104 /// \brief 00105 /// When executing the operation ExecuteWithLock lock 00106 /// conflicts may occur. Those lock conflicts are reported. 00107 /// This function returns a lock conflict reader 00108 /// providing access to the list of lock conflicts that occurred 00109 /// during the execution of the operation. 00110 /// 00111 /// \return 00112 /// Returns a lock conflict reader. 00113 /// 00114 __property NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockConflictReader* get_LockConflicts(); 00115 }; 00116 00117 END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE 00118 00119
Comments or suggestions? Send us feedback. |