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

# IGetLockedObjects.h

Go to the documentation of this file.

    00001 #ifndef _IGETLOCKEDOBJECTS_H_
    00002 #define _IGETLOCKEDOBJECTS_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/Commands/Locking/ILockedObjectReader.h>
    00029
    00030 /// \brief
    00031 /// The FdoIGetLockedObjects interface defines the GetLockedObjects command, which
    00032 /// gets a list of all objects that are currently locked by a particular user.
    00033 class FdoIGetLockedObjects : public FdoICommand
    00034 {
    00035   public:
    00036     /// \brief
    00037     /// Gets the name of the user whose locked objects you want to list.
    00038     ///
    00039     /// \return
    00040     /// Returns the name of the user
    00041     ///
    00042     FDO_API virtual FdoString* GetLockOwner() = 0;
    00043
    00044     /// \brief
    00045     /// Sets the name of the user whose locked objects you want to list.
    00046     ///
    00047     /// \param value
    00048     /// Input the name of the user
    00049     ///
    00050     /// \return
    00051     /// Returns nothing
    00052     ///
    00053     FDO_API virtual void SetLockOwner(FdoString* value) = 0;
    00054
    00055     /// \brief
    00056     /// Executes the GetLockedObjects command, returning an FdoILockedObjectReader.
    00057     ///
    00058     /// \return
    00059     /// Returns a list of all of the objects currently locked by a particular user.i The list might be empty if the user does not have anything locked.
    00060     ///
    00061     FDO_API virtual FdoILockedObjectReader* Execute() = 0;
    00062 };
    00063 #endif
    00064
    00065

Please send us your comment about this page