| FDO API Reference | Feature Data Objects |
00001 #ifndef _IDESCRIBESCHEMA_H_ 00002 #define _IDESCRIBESCHEMA_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/Schema/FeatureSchemaCollection.h> 00029 #include <Fdo/Connections/IConnection.h> 00030 00031 /// \brief 00032 /// The FdoIDescribeSchema interface defines the DescribeSchema command, which 00033 /// describes the feature schemas available from the connection. The DescribeSchema 00034 /// command can describe a single schema or all schemas available from 00035 /// the connection. The Execute operation returns an FdoFeatureSchemaCollection 00036 /// object. 00037 class FdoIDescribeSchema : public FdoICommand 00038 { 00039 friend class FdoIConnection; 00040 00041 public: 00042 /// \brief 00043 /// Gets the name of the schema to describe. This function is optional; 00044 /// if not specified, execution of the command will describe all schemas. 00045 /// 00046 /// \return 00047 /// Returns the schema name 00048 /// 00049 FDO_API virtual FdoString* GetSchemaName() = 0; 00050 00051 /// \brief 00052 /// Sets the name of the schema to describe. This function is optional; if not 00053 /// specified execution of the command will describe all schemas. 00054 /// 00055 /// \param value 00056 /// Input the schema name 00057 /// 00058 /// \return 00059 /// Returns nothing 00060 /// 00061 FDO_API virtual void SetSchemaName(FdoString* value) = 0; 00062 00063 /// \brief 00064 /// Executes the DescribeSchema command and returns a 00065 /// FdoFeatureSchemaCollection. If a schema name is given that has 00066 /// references to another schema, the dependent schemas will 00067 /// be returned as well. If the specified schema name does not exist, 00068 /// the Execute method throws an exception. 00069 /// 00070 /// \return 00071 /// Returns the schema collection representing the schema created. 00072 /// The element states for all elements will be set to FdoSchemaElementState_Unchanged. 00073 /// Each provider-specific implementation of Execute() can ensure 00074 /// that this is the case by 00075 /// calling FdoFeatureSchema::AcceptChanges() for each feature schema 00076 /// in the returned collection. 00077 /// 00078 FDO_API virtual FdoFeatureSchemaCollection* Execute() = 0; 00079 }; 00080 #endif 00081 00082
| Comments or suggestions? Send us feedback. |