FDO .NET API Reference Feature Data Objects

mgICommandCapabilities.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 BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
00022 
00023 /// \ingroup (OSGeoFDOConnectionsCapabilities)
00024 /// \interface OSGeo::FDO::Connections::Capabilities::ICommandCapabilities
00025 /// \brief
00026 /// The ICommandCapabilities interface declares the feature provider's level
00027 /// of support for Commands.
00028 public __gc __interface ICommandCapabilities : public System::IDisposable
00029 {
00030 public:
00031     /// \brief
00032     /// Gets an array of the CommandType values supported by the feature provider.
00033     /// 
00034     /// \return
00035     /// Returns the list of commands
00036     /// 
00037     __property System::Int32 get_Commands() [];
00038 
00039     /// \brief
00040     /// Determines if commands support parameterization.
00041     /// 
00042     /// \return
00043     /// Returns true if commands support parameterization
00044     /// 
00045     System::Boolean SupportsParameters();
00046 
00047     /// \brief
00048     /// Determines if the feature provider supports command execution timeout.
00049     /// 
00050     /// \return
00051     /// Returns true if the feature provider supports timeout.
00052     /// 
00053     System::Boolean SupportsTimeout();
00054 
00055     /// \brief
00056     /// Determines if the feature provider can use expressions for properties with Select and SelectAggregate commands.
00057     /// 
00058     /// \return
00059     /// Returns true if the feature provider supports select expressions.
00060     /// 
00061     System::Boolean SupportsSelectExpressions();
00062 
00063     /// \brief
00064     /// Determines if simple functions can be used in Select and SelectAggregates command. 
00065     /// Aggregate functions can only be used in the SelectAggregates command. Capability for using SelectAggregates is found in 
00066     /// CommandCapabilities.
00067     /// 
00068     /// \return
00069     /// Returns true if the feature provider supports select simple functions.
00070     /// 
00071     System::Boolean SupportsSelectFunctions();
00072 
00073     /// \brief
00074     /// Determines if Distinct can be used with SelectAggregates. This can be true only 
00075     /// if the SelectAggregates command is supported by the provider.
00076     /// 
00077     /// \return
00078     /// Returns true if the feature provider supports select distinct.
00079     /// 
00080     System::Boolean SupportsSelectDistinct();
00081 
00082     /// \brief
00083     /// Determines  if ordering is available in the Select and SelectAggregates command.
00084     /// 
00085     /// \return
00086     /// Returns true if the feature provider supports select ordering.
00087     /// 
00088     System::Boolean SupportsSelectOrdering();
00089 
00090     /// \brief
00091     /// Determines if a grouping criteria is available in the SelectAggregates command. 
00092     /// This can be true only if the SelectAggregates command is supported by the provider. 
00093     /// 
00094     /// \return
00095     /// Returns true if the feature provider supports select grouping.
00096     /// 
00097     /// Note: Aggregate functions can be supported without also supporting grouping criteria 
00098     /// (but not vice versa).
00099     System::Boolean SupportsSelectGrouping();
00100 
00101 };
00102 
00103 END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
00104 
00105 

Comments or suggestions? Send us feedback.