- Main Page
- Related Pages
- Modules
- Classes
- Files

# IListDataStores.h

Go to the documentation of this file.

    00001 #ifndef _ILISTDATASTORES_H_
    00002 #define _ILISTDATASTORES_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/Connections/IConnection.h>
    00028 #include <Fdo/Commands/ICommand.h>
    00029 #include <Fdo/Commands/DataStore/IDataStoreReader.h>
    00030
    00031 /// \brief
    00032 /// The FdoIListDataStores interface defines the list datastores command,
    00033 /// which provides a way to get a list of datastores at a particular server.
    00034 class FdoIListDataStores : public FdoICommand
    00035 {
    00036 friend class FdoIConnection;
    00037
    00038 public:
    00039
    00040     /// \brief
    00041     /// Gets the flag that indicates whether to include or
    00042     /// not include Non-FDO enabled datastores in the returned list.
    00043     /// These are also referred to as foreign datastores.
    00044     ///
    00045     /// \return
    00046     /// Returns the flag
    00047     ///
    00048     FDO_API virtual bool GetIncludeNonFdoEnabledDatastores() = 0;
    00049
    00050     /// \brief
    00051     /// Sets the flag to indicate whether to include or not include
    00052     /// Non-FDO enabled datastores in the returned list. These are also
    00053     /// referred to as foreign datastores.
    00054     ///
    00055     /// \return
    00056     /// Returns nothing
    00057     ///
    00058     FDO_API virtual void SetIncludeNonFdoEnabledDatastores(bool include) = 0;
    00059
    00060     /// \brief
    00061     /// Executes the FdoIListDataStores command.
    00062     ///
    00063     /// \return
    00064     /// Returns nothing
    00065     ///
    00066     FDO_API virtual FdoIDataStoreReader* Execute() = 0;
    00067 };
    00068
    00069 #endif
    00070
    00071

Please send us your comment about this page