| FDO API Reference | Feature Data Objects |
00001 #ifndef _IDESCRIBESCHEMAMAPPING_H_ 00002 #define _IDESCRIBESCHEMAMAPPING_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/ICommand.h> 00028 #include <Fdo/Commands/Schema/PhysicalSchemaMappingCollection.h> 00029 #include <Fdo/Connections/IConnection.h> 00030 00031 /// \brief 00032 /// The FdoIDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which 00033 /// describes the logical to physical schema mappings for feature schemas 00034 /// available from the connection. The DescribeSchemaMapping 00035 /// command can describe the mappings for a single schema or all schemas available from 00036 /// the connection. The Execute operation returns an FdoPhysicalSchemaMappingCollection 00037 /// object. 00038 class FdoIDescribeSchemaMapping : public FdoICommand 00039 { 00040 friend class FdoIConnection; 00041 00042 public: 00043 /// \brief 00044 /// Gets the name of the schema for which to describe 00045 /// schema mappings. 00046 /// 00047 /// \return 00048 /// Returns the schema name 00049 /// 00050 FDO_API virtual FdoString* GetSchemaName() = 0; 00051 00052 /// \brief 00053 /// Sets the name of the schema to describe. This function is optional; if not 00054 /// specified, execution of the command will describe the mappings for 00055 /// all schemas. 00056 /// 00057 /// \param value 00058 /// Input the schema name 00059 /// 00060 /// \return 00061 /// Returns nothing 00062 /// 00063 FDO_API virtual void SetSchemaName(FdoString* value) = 0; 00064 00065 /// \brief 00066 /// Gets the current "include default mappings" setting. 00067 /// 00068 /// \return 00069 /// Returns True if Execute() will include default mappings. 00070 /// 00071 FDO_API virtual FdoBoolean GetIncludeDefaults() = 0; 00072 00073 /// \brief 00074 /// Sets the "include default mappings" setting. 00075 /// 00076 /// \param includeDefaults 00077 /// Input True: Execute() will return 00078 /// all mappings for the feature schema(s). 00079 /// False: Execute() will not include default logical to physical 00080 /// mappings, only those mappings that have been overridden will 00081 /// be returned. 00082 /// 00083 /// \return 00084 /// Returns nothing 00085 /// 00086 FDO_API virtual void SetIncludeDefaults( FdoBoolean includeDefaults ) = 0; 00087 00088 /// \brief 00089 /// Executes the DescribeSchemaMapping command and returns a 00090 /// FdoPhysicalSchemaMappingCollection. If the specified schema name does not exist, 00091 /// the Execute method throws an exception. 00092 /// 00093 /// \return 00094 /// Returns the schema mapping collection for the requested feature schemas. 00095 /// 00096 FDO_API virtual FdoPhysicalSchemaMappingCollection* Execute() = 0; 00097 }; 00098 #endif 00099 00100
| Comments or suggestions? Send us feedback. |