| FDO API Reference | Feature Data Objects |
00001 #ifndef _IDESTROYSCHEMA_H_ 00002 #define _IDESTROYSCHEMA_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 00029 /// \brief 00030 /// The FdoIDestroySchema interface defines the DestroySchema command, which 00031 /// destroys a schema definition, including all class definitions, relationship 00032 /// definitions, and instance data within it. If elements in other schemas refer 00033 /// to the schema to be destroyed command, execution will fail. Input to the 00034 /// delete schema command is the name of the schema to be destroyed. 00035 class FdoIDestroySchema : public FdoICommand 00036 { 00037 public: 00038 /// \brief 00039 /// Gets the name of the schema to destroy as a string. 00040 /// 00041 /// \return 00042 /// Returns the name of the schema to destroy 00043 /// 00044 FDO_API virtual FdoString* GetSchemaName() = 0; 00045 00046 /// \brief 00047 /// Sets the name of the schema to destroy as a string. 00048 /// 00049 /// \param value 00050 /// Input the name of the schema to destroy 00051 /// 00052 /// \return 00053 /// Returns nothing 00054 /// 00055 FDO_API virtual void SetSchemaName(FdoString* value) = 0; 00056 00057 /// \brief 00058 /// Executes the destroy schema command, which removes the schema, class 00059 /// definitions, relation definitions, and all instance data from the DataStore. 00060 /// If elements in other schemas refer to the schema to be destroyed 00061 /// an exception is thrown. 00062 /// 00063 /// \return 00064 /// Returns nothing 00065 /// 00066 FDO_API virtual void Execute() = 0; 00067 }; 00068 #endif 00069 00070
| Comments or suggestions? Send us feedback. |