00001 #ifndef _IGETSPATIALINDEXES_H_
00002 #define _IGETSPATIALINDEXES_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/Commands/ICommand.h"
00038 #include "Rdbms/ISpatialIndexReader.h"
00039
00040 /// \brief
00041 /// The IGetSpatialIndexes interface defines the GetSpatialIndexes command,
00042 /// which enumerates the existing spatial indexes.
00043 class FdoIGetSpatialIndexes : public FdoICommand
00044 {
00045 public:
00046 /// \brief
00047 /// Gets a Boolean flag that indicates if the GetSpatialIndexes command
00048 /// will return only the spatial indexes of the active spatial contexts or all spatial indexes.
00049 /// The default value of this flag is false, return all spatial indexes.
00050 ///
00051 /// \return
00052 /// Returns the value of the Boolean flag
00053 ///
00054 FDO_API virtual const bool GetActiveOnly() = 0;
00055
00056 /// \brief
00057 /// Gets a Boolean flag that indicates if the GetSpatialIndexes command
00058 /// will return only the spatial indexes of the active spatial contexts or all spatial indexes.
00059 ///
00060 /// \param value
00061 /// Input the Boolean flag
00062 ///
00063 /// \return
00064 /// Returns nothing
00065 ///
00066 FDO_API virtual void SetActiveOnly(const bool value) = 0;
00067
00068 /// \brief
00069 /// Executes the GetSpatialIndexes command returning an ISpatialIndexReader.
00070 ///
00071 /// \return
00072 /// Returns ISpatialIndexReader
00073 ///
00074 FDO_API virtual FdoISpatialIndexReader* Execute() = 0;
00075 };
00076 #endif
00077
00078