FDO .NET API Reference Feature Data Objects

mgIDestroySchema.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\mgICommand.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
00024 
00025 /// \ingroup (OSGeoFDOCommandsSchema)
00026 /// \interface OSGeo::FDO::Commands::Schema::IDestroySchema
00027 /// \brief
00028 /// The IDestroySchema interface defines the DestroySchema command, which
00029 /// destroys a schema definition, including all class definitions, relationship
00030 /// definitions, and instance data within it. If elements in other schemas refer
00031 /// to the schema to be destroyed command, execution will fail. Input to the
00032 /// delete schema command is the name of the schema to be destroyed.
00033 public __gc __interface IDestroySchema : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00034 {
00035 public:
00036     /// \brief
00037     /// Gets the name of the schema to destroy as a string.
00038     /// 
00039     /// \return
00040     /// Returns the name of the schema to destroy
00041     /// 
00042     __property System::String* get_SchemaName();
00043 
00044     /// \brief
00045     /// Sets the name of the schema to destroy as a string.
00046     /// 
00047     /// \param value 
00048     /// Input the name of the schema to destroy
00049     /// 
00050     /// \return
00051     /// Returns nothing
00052     /// 
00053     __property System::Void set_SchemaName(System::String* value);
00054 
00055     /// \brief
00056     /// Executes the destroy schema command, which removes the schema, class
00057     /// definitions, relation definitions, and all instance data from the DataStore.
00058     /// If elements in other schemas refer to the schema to be destroyed
00059     /// an exception is thrown.
00060     /// 
00061     /// \return
00062     /// Returns nothing
00063     /// 
00064     System::Void Execute();
00065 };
00066 
00067 END_NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA
00068 
00069 

Comments or suggestions? Send us feedback.