FDO API Reference | Feature Data Objects |
00001 #ifndef _IBASESELECT_H_ 00002 #define _IBASESELECT_H_ 00003 // 00004 00005 // 00006 // Copyright (C) 2004-2006 Autodesk, Inc. 00007 // 00008 // This library is free software; you can redistribute it and/or 00009 // modify it under the terms of version 2.1 of the GNU Lesser 00010 // General Public License as published by the Free Software Foundation. 00011 // 00012 // This library is distributed in the hope that it will be useful, 00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00015 // Lesser General Public License for more details. 00016 // 00017 // You should have received a copy of the GNU Lesser General Public 00018 // License along with this library; if not, write to the Free Software 00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00020 // 00021 00022 #ifdef _WIN32 00023 #pragma once 00024 #endif 00025 00026 #include <FdoStd.h> 00027 #include <Fdo/Commands/IFeatureCommand.h> 00028 #include <Fdo/Commands/Locking/LockType.h> 00029 #include <Fdo/Commands/Locking/LockStrategy.h> 00030 #include <Fdo/Connections/IConnection.h> 00031 #include <Fdo/Commands/Feature/IFeatureReader.h> 00032 #include <Fdo/Commands/Locking/ILockConflictReader.h> 00033 #include <Fdo/Commands/IdentifierCollection.h> 00034 #include <Fdo/Commands/OrderingOption.h> 00035 00036 /// \brief 00037 /// The FdoISelect interface defines the Select command, which queries for features 00038 /// of a given class that match the specified criteria. Input to the select 00039 /// command includes the name of the class, the list of properties to be 00040 /// returned, and a filter. All but the class name is optional. If the list of 00041 /// properties to be returned is empty then all properties are returned. The 00042 /// filter may be specified either as text or as an expression tree (most likely 00043 /// produced by a query builder). The result of executing a select command is an 00044 /// FdoIFeatureReader reference (see "Reading Features"). If the feature provider 00045 /// supports locking, then the select command can optionally lock all of the 00046 /// features selected, via the ExecuteWithLock method (see "Locking 00047 /// Commands" for more information on locking features). 00048 class FdoIBaseSelect : public FdoIFeatureCommand 00049 { 00050 friend class FdoIConnection; 00051 00052 public: 00053 /// \brief 00054 /// Gets the FdoIdentifierCollection that holds the list of property names to 00055 /// return with the result. If empty all properties of the specified class 00056 /// are returned. 00057 /// 00058 /// \return 00059 /// Returns the list of property names. 00060 /// 00061 FDO_API virtual FdoIdentifierCollection* GetPropertyNames() = 0; 00062 00063 /// \brief 00064 /// Gets the FdoIdentifierCollection that holds the list of order by property names. If empty no ordering is used. This list is initially 00065 /// empty and the caller need to add the property that the command should use as a order by criteria. 00066 /// 00067 /// \return 00068 /// Returns the list of group by property names. 00069 /// 00070 FDO_API virtual FdoIdentifierCollection* GetOrdering() = 0; 00071 00072 /// \brief 00073 /// Set the ordering option of the selection. This is only used if the ordering collection is not empty. 00074 /// 00075 /// \param option 00076 /// Is the ordering option and should be set to one of FdoOrderingOption_Ascending or FdoOrderingOption_Descending. 00077 /// FdoOrderingOption_Ascending is the default value. 00078 /// 00079 /// \return 00080 /// Returns nothing 00081 /// 00082 FDO_API virtual void SetOrderingOption( FdoOrderingOption option ) = 0; 00083 00084 /// \brief 00085 /// Gets the ordering option. 00086 /// 00087 /// \return 00088 /// Returns the ordering option. 00089 /// 00090 FDO_API virtual FdoOrderingOption GetOrderingOption( ) = 0; 00091 00092 }; 00093 #endif 00094 00095
Comments or suggestions? Send us feedback. |