FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.