FDO .NET API Reference Feature Data Objects

mgIConnectionCapabilities.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\SpatialContext\mgSpatialContextExtentType.h"
00022 #include "FDO\Commands\Locking\mgLockType.h"
00023 #include "FDO\Connections\Capabilities\mgThreadCapability.h"
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00026 public __value enum SpatialContextExtentType;
00027 END_NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT
00028 
00029 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
00030 public __value enum LockType;
00031 END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
00032 
00033 BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
00034 
00035 /// \ingroup (OSGeoFDOConnectionsCapabilities)
00036 /// \interface OSGeo::FDO::Connections::Capabilities::IConnectionCapabilities
00037 /// \brief
00038 /// The IConnectionCapabilities interface declares the feature provider's capabilities.
00039 public __gc __interface IConnectionCapabilities : public System::IDisposable
00040 {
00041 public:
00042     /// \brief
00043     /// Gets an ThreadCapability value that declares the feature provider's level of thread safety.
00044     /// 
00045     /// \return
00046     /// Returns the connection thread capability.
00047     /// 
00048     __property NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES::ThreadCapability get_ThreadCapability();
00049 
00050     /// \brief
00051     /// Gets the spatial context extent types supported by the feature provider.
00052     /// 
00053     /// \return
00054     /// Returns the list of spatial context extent types.
00055     /// 
00056     __property NAMESPACE_OSGEO_FDO_COMMANDS_SPATIALCONTEXT::SpatialContextExtentType get_SpatialContextTypes() [];
00057 
00058     /// \brief
00059     /// Determines if the feature provider supports persistent locking.
00060     /// 
00061     /// \return
00062     /// Returns true if the feature provider supports persistent locking.
00063     /// 
00064     System::Boolean SupportsLocking();
00065 
00066     /// \brief
00067     /// Gets an array of the LockType values supported by the feature provider.
00068     /// 
00069     /// \return
00070     /// Returns the list of lock types
00071     /// 
00072     __property NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::LockType get_LockTypes() [];
00073 
00074     /// \brief
00075     /// Determines if the feature provider supports connection timeout.
00076     /// 
00077     /// \return
00078     /// Returns true if the feature provider supports connection timeout.
00079     /// 
00080     System::Boolean SupportsTimeout();
00081 
00082     /// \brief
00083     /// Determines if the feature provider supports transactions.
00084     /// 
00085     /// \return
00086     /// Returns true if the feature provider supports transactions.
00087     /// 
00088     System::Boolean SupportsTransactions();
00089 
00090     /// \brief
00091     /// Determines true if the feature provider supports long transactions.
00092     /// 
00093     /// \return
00094     /// Returns true if the feature provider supports long transactions.
00095     /// 
00096     System::Boolean SupportsLongTransactions();
00097 
00098     /// \brief
00099     /// Determines if the feature provider supports SQL commands.
00100     /// 
00101     /// \return
00102     /// Returns true if the feature provider supports SQL commands.
00103     /// 
00104     System::Boolean SupportsSQL();
00105 
00106     /// \brief
00107     /// Determines if the feature provider supports XML configuration.
00108     /// 
00109     /// \return
00110     /// Returns true if the feature provider supports the setting of a configuration.
00111     /// 
00112     System::Boolean SupportsConfiguration();
00113 
00114     /// \brief
00115     /// Determines if the provider supports multiple spatial contexts.
00116     /// 
00117     /// \return
00118     /// Returns true if the provider supports multiple spatial contexts.
00119     /// 
00120     System::Boolean SupportsMultipleSpatialContexts();
00121 
00122     /// \brief
00123     /// Determines if the provider supports specifying the coordinate system by name or ID without specifying the WKT
00124     /// when creating a new spatial context.
00125     /// 
00126     /// \return
00127     /// Returns true if the provider supports specifying the coordinate system by name or ID without specifying the WKT
00128     /// when creating a new spatial context.
00129     /// 
00130     System::Boolean SupportsCSysWKTFromCSysName();
00131 
00132     /// \brief
00133     /// Determines if the provider can support the flush function. Flush is used to write any outstanding data
00134     /// to the datastore. This is mainly used by the file based providers to ensure that any cached data is writen to the file.
00135     ///
00136     /// \return
00137     /// Returns true if the provider or datastore can support the flush function.
00138     ///
00139     System::Boolean SupportsFlush();
00140 };
00141 
00142 END_NAMESPACE_OSGEO_FDO_CONNECTIONS_CAPABILITIES
00143 
00144 

Comments or suggestions? Send us feedback.