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

# IGetLongTransactions.h

Go to the documentation of this file.

    00001 #ifndef _IGETLONGTRANSACTIONS_H_
    00002 #define _IGETLONGTRANSACTIONS_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/LongTransaction/ILongTransactionReader.h>
    00029 #include <Fdo/Commands/ICommand.h>
    00030
    00031 /// \brief
    00032 /// The FdoIGetLongTransactions interface defines the GetLongTransactions
    00033 /// command. It allows a user to retrieve long transaction information for all or
    00034 /// a specific long transaction. The command returns a FdoILongTransactionReader
    00035 /// object enumerating the identified long transactions.
    00036 class FdoIGetLongTransactions : public FdoICommand
    00037 {
    00038     friend class FdoIConnection;
    00039
    00040 public:
    00041
    00042     /// \brief
    00043     /// Sets the name of the long transaction for which information
    00044     /// should be retrieved. The function can also be used to nullify the
    00045     /// property by using a NULL pointer as the function's parameter. If the
    00046     /// the property is not set, the function returns information for all
    00047     /// available long transactions.
    00048     ///
    00049     /// \return
    00050     /// Returns nothing
    00051     ///
    00052     FDO_API virtual void SetName(FdoString* value) = 0;
    00053
    00054     /// \brief
    00055     /// Gets the currently set name of the long transaction for which
    00056     /// the long transaction information should be retrieved. If the property
    00057     /// is not set, the function returns a NULL pointer.
    00058     ///
    00059     /// \return
    00060     /// Returns a long transaction name.
    00061     ///
    00062     FDO_API virtual FdoString* GetName() = 0;
    00063
    00064     /// \brief
    00065     /// Executes the GetLongTransactions command returning a reference to an
    00066     /// FdoILongTransactionReader.
    00067     ///
    00068     /// \return
    00069     /// Returns a long transaction reader
    00070     ///
    00071     FDO_API virtual FdoILongTransactionReader* Execute() = 0;
    00072
    00073 };
    00074 #endif
    00075
    00076

Please send us your comment about this page