00001 #ifndef _IDESTROYSPATIALINDEX_H_
00002 #define _IDESTROYSPATIALINDEX_H_
00003 //
00004 //
00005 // (C) Copyright 1990-2005 by Autodesk, Inc.
00006 //
00007 //
00008 //
00009 // By using this code, you are agreeing to the terms
00010 // and conditions of the License Agreement that appeared
00011 // and was accepted upon download or installation
00012 // (or in connection with the download or installation)
00013 // of the Autodesk software in which this code is included.
00014 // All permissions on use of this code are as set forth
00015 // in such License Agreement provided that the above copyright
00016 // notice appears in all authorized copies and that both that
00017 // copyright notice and the limited warranty and
00018 // restricted rights notice below appear in all supporting
00019 // documentation.
00020 //
00021 // AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
00022 // AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
00023 // MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  AUTODESK, INC.
00024 // DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
00025 // UNINTERRUPTED OR ERROR FREE.
00026 //
00027 // Use, duplication, or disclosure by the U.S. Government is subject to
00028 // restrictions set forth in FAR 52.227-19 (Commercial Computer
00029 // Software - Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
00030 // (Rights in Technical Data and Computer Software), as applicable.
00031 // 
00032 #ifdef _WIN32
00033 #pragma once
00034 #endif
00035 
00036 #include "FdoStd.h"
00037 #include "Fdo/Schema/PropertyDefinition.h"
00038 #include "Fdo/Commands/ICommand.h"
00039 
00040 /// \brief
00041 /// The IDestroySpatialIndex interface defines the DestroySpatialIndex
00042 /// command, which drops an existing spatial index. Input to the command is
00043 /// the name of the index to drop. 
00044 class FdoIDestroySpatialIndex : public FdoICommand
00045 {
00046 public:
00047     /// \brief
00048     /// Gets the name of the spatial index to destroy as a String.
00049     /// 
00050     /// \return
00051     /// Returns the name of the spatial index to be drop
00052     /// 
00053     FDO_API virtual const wchar_t* GetName() = 0;
00054 
00055     /// \brief
00056     /// Sets the name of the spatial index to drop as a String.
00057     /// 
00058     /// \param value 
00059     /// Input the name of the spatial index to be drop
00060     /// 
00061     /// \return
00062     /// Returns nothing
00063     /// 
00064     FDO_API virtual void SetName(const wchar_t* value) = 0;
00065 
00066     /// \brief
00067     /// Sets the desired value of the geometric property.
00068     /// 
00069     /// \param value 
00070     /// Input the geometric property definition
00071     /// 
00072     /// \return
00073     /// Returns nothing
00074     /// 
00075     FDO_API virtual void SetGeometricProperty(FdoGeometricPropertyDefinition *pGeomProp ) = 0;
00076 
00077     /// \brief
00078     /// Gets the geometric property previously set, if any.
00079     /// 
00080     /// \return
00081     /// Returns NULL if not set or a pointer to a geometry property definition
00082     /// 
00083     FDO_API virtual FdoGeometricPropertyDefinition *GetGeometricProperty() = 0;
00084 
00085     /// \brief
00086     /// Executes the DestroySpatialIndex command dropping the specified 
00087     /// spatial index. An exception is thrown if the spatial index does not exist.
00088     /// 
00089     /// \return
00090     /// Returns nothing
00091     /// 
00092     FDO_API virtual void Execute() = 0;
00093 };
00094 #endif
00095 
00096