- Main Page
- Related Pages
- Modules
- Classes
- Files

# ICommandCapabilities.h

Go to the documentation of this file.

    00001 #ifndef _ICOMMANDCAPABILITIES_H_
    00002 #define _ICOMMANDCAPABILITIES_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
    00028 /// \brief
    00029 /// The FdoICommandCapabilities interface declares the feature provider's level
    00030 /// of support for Commands.
    00031 class FdoICommandCapabilities : public FdoIDisposable
    00032 {
    00033 public:
    00034     /// \brief
    00035     /// Gets an array of the FdoCommandType values supported by the feature provider.
    00036     ///
    00037     /// \param size
    00038     /// Output the number of commands
    00039     ///
    00040     /// \return
    00041     /// Returns the list of commands
    00042     ///
    00043     FDO_API virtual FdoInt32* GetCommands(FdoInt32& size) = 0;
    00044
    00045     /// \brief
    00046     /// Determines if commands support parameterization.
    00047     ///
    00048     /// \return
    00049     /// Returns true if commands support parameterization
    00050     ///
    00051     FDO_API virtual bool SupportsParameters() = 0;
    00052
    00053     /// \brief
    00054     /// Determines if the feature provider supports command execution timeout.
    00055     ///
    00056     /// \return
    00057     /// Returns true if the feature provider supports timeout.
    00058     ///
    00059     FDO_API virtual bool SupportsTimeout() = 0;
    00060
    00061     /// \brief
    00062     /// Determines if the feature provider can use expressions for properties with Select and SelectAggregate commands.
    00063     ///
    00064     /// \return
    00065     /// Returns true if the feature provider supports select expressions.
    00066     ///
    00067     FDO_API virtual bool SupportsSelectExpressions() = 0;
    00068
    00069     /// \brief
    00070     /// Determines if simple functions can be used in Select and SelectAggregates command.
    00071     /// Aggregate functions can only be used in the SelectAggregates command. Capability for using SelectAggregates is found in
    00072     /// CommandCapabilities.
    00073     ///
    00074     /// \return
    00075     /// Returns true if the feature provider supports select simple functions.
    00076     ///
    00077     FDO_API virtual bool SupportsSelectFunctions() = 0;
    00078
    00079     /// \brief
    00080     /// Determines if Distinct can be used with SelectAggregates. This can be true only
    00081     /// if the SelectAggregates command is supported by the provider.
    00082     ///
    00083     /// \return
    00084     /// Returns true if the feature provider supports select distinct.
    00085     ///
    00086     FDO_API virtual bool SupportsSelectDistinct() = 0;
    00087
    00088     /// \brief
    00089     /// Determines  if ordering is available in the Select and SelectAggregates command.
    00090     ///
    00091     /// \return
    00092     /// Returns true if the feature provider supports select ordering.
    00093     ///
    00094     FDO_API virtual bool SupportsSelectOrdering() = 0;
    00095
    00096     /// \brief
    00097     /// Determines if a grouping criteria is available in the SelectAggregates command.
    00098     /// This can be true only if the SelectAggregates command is supported by the provider.
    00099     ///
    00100     /// \return
    00101     /// Returns true if the feature provider supports select grouping.
    00102     ///
    00103     /// \note
    00104     /// Aggregate functions can be supported without also supporting grouping criteria
    00105     /// (but not vice versa).
    00106     FDO_API virtual bool SupportsSelectGrouping() = 0;
    00107 };
    00108 #endif
    00109
    00110

Please send us your comment about this page