FDO .NET API Reference Feature Data Objects

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

Comments or suggestions? Send us feedback.