FDO .NET API Reference Feature Data Objects

mgIBaseSelect.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\mgIFeatureCommand.h"
00022 #include "FDO\Commands\mgOrderingOption.h"
00023 
00024 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS
00025 public __gc class IdentifierCollection;
00026 END_NAMESPACE_OSGEO_FDO_COMMANDS
00027 
00028 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00029 
00030 /// \ingroup (OSGeoFDOCommandsFeature)
00031 /// \interface OSGeo::FDO::Commands::Feature::IBaseSelect
00032 /// \brief
00033 /// The IBaseSelect interface defines a base interface for the the 
00034 /// FDO ISelect command, which queries for features
00035 /// of a given class that match the specified criteria. Input to the select
00036 /// command includes the name of the class, the list of properties to be
00037 /// returned, and a filter. All but the class name is optional. If the list of
00038 /// properties to be returned is empty then all properties are returned. The
00039 /// filter may be specified either as text or as an expression tree (most likely
00040 /// produced by a query builder). The result of executing a select command is an
00041 /// IFeatureReader reference (see "Reading Features"). If the feature provider
00042 /// supports locking, then the select command can optionally lock all of the
00043 /// features selected, via the ExecuteWithLock method (see "Locking
00044 /// Commands" for more information on locking features).
00045 public __gc __interface IBaseSelect : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommand
00046 {
00047 public:
00048     /// \brief
00049     /// Gets the IdentifierCollection that holds the list of property names to 
00050     /// return with the result. If empty all properties of the specified class
00051     /// are returned.
00052     /// 
00053     /// \return
00054     /// Returns the list of property names.
00055     /// 
00056     __property NAMESPACE_OSGEO_FDO_COMMANDS::IdentifierCollection* get_PropertyNames();
00057 
00058     /// \brief
00059     /// Gets the IdentifierCollection that holds the list of order by property names. If empty no ordering is used. This list is initially
00060     /// empty and the caller need to add the property that the command should use as a order by criteria.
00061     /// 
00062     /// \return
00063     /// Returns the list of group by property names.
00064     /// 
00065     __property NAMESPACE_OSGEO_FDO_COMMANDS::IdentifierCollection* get_Ordering();
00066 
00067     /// \brief
00068     /// Set the ordering option of the selection. This is only used if the ordering collection is not empty.
00069     /// 
00070     /// \param option 
00071     /// Is the ordering option and should be set to one of OrderingOption_Ascending or OrderingOption_Descending.
00072     /// OrderingOption_Ascending is the default value.
00073     /// 
00074     /// \return
00075     /// Returns nothing
00076     /// 
00077     __property System::Void set_OrderingOption(NAMESPACE_OSGEO_FDO_COMMANDS::OrderingOption option);
00078 
00079     /// \brief
00080     /// Gets the ordering option.
00081     /// 
00082     /// \return
00083     /// Returns the ordering option.
00084     /// 
00085     __property NAMESPACE_OSGEO_FDO_COMMANDS::OrderingOption get_OrderingOption();
00086 };
00087 
00088 END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE
00089 
00090 

Comments or suggestions? Send us feedback.