00001 #ifndef _IGETCLASSNAMES_H_ 00002 #define _IGETCLASSNAMES_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 #include <Fdo/Schema/FeatureSchemaCollection.h> 00029 #include <Fdo/Connections/IConnection.h> 00030 00031 /// \brief 00032 /// The FdoIGetClassNames interface defines the GetClassNames command, which 00033 /// retrieves the list of available class names, qualified by the feature schema name. 00034 /// The Execute operation returns an FdoStringCollection 00035 /// object. 00036 class FdoIGetClassNames : public FdoICommand 00037 { 00038 friend class FdoIConnection; 00039 00040 public: 00041 /// \brief 00042 /// Gets the name of the schema for the enumeration. This function is optional; 00043 /// if not specified, execution of the command will enumerate the classes in all schemas. 00044 /// 00045 /// \return 00046 /// Returns the schema name 00047 /// 00048 FDO_API virtual FdoString* GetSchemaName() = 0; 00049 00050 /// \brief 00051 /// Sets the name of the schema for the enumeration. This function is optional; if not 00052 /// specified execution of the command will enumerate the classes in all schemas. 00053 /// 00054 /// \param value 00055 /// Input the schema name 00056 /// 00057 /// \return 00058 /// Returns nothing 00059 /// 00060 FDO_API virtual void SetSchemaName(FdoString* value) = 0; 00061 00062 /// \brief 00063 /// Executes the GetClassNames command and returns a 00064 /// FdoStringCollection. If the specified schema name does not exist, 00065 /// the Execute method throws an exception. 00066 /// 00067 /// \return 00068 /// Returns the string collection of the feature classes for the specified schema. 00069 FDO_API virtual FdoStringCollection* Execute() = 0; 00070 }; 00071 #endif 00072 00073