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

# IReleaseLock.h

Go to the documentation of this file.

    00001 #ifndef _IRELEASELOCK_H_
    00002 #define _IRELEASELOCK_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/IFeatureCommand.h>
    00028 #include <Fdo/Connections/IConnection.h>
    00029
    00030 /// \brief
    00031 /// The FdoIReleaseLock interface defines the ReleaseLock command, which releases
    00032 /// locks from feature instances of a given class that match the specified
    00033 /// criteria. Input to the release lock command includes the name of the class
    00034 /// and filter criteria by which to identify the instances to be unlocked. The
    00035 /// filter may be specified either as text or as an expression tree (most likely
    00036 /// produced by a query builder). The ability to successfully execute the command
    00037 /// might be restricted by the datastore security if the lock doesn’t belong to the
    00038 /// user executing the command.
    00039 class FdoIReleaseLock : public FdoIFeatureCommand
    00040 {
    00041 public:
    00042     /// \brief
    00043     /// Gets the name of the user who owns the lock to release.
    00044     ///
    00045     /// \return
    00046     /// Returns name of the lock owner. If the name was not set, it returns the name of the caller.
    00047     ///
    00048     FDO_API virtual FdoString* GetLockOwner() = 0;
    00049
    00050     /// \brief
    00051     /// Sets the name of the user who owns the lock to release.
    00052     ///
    00053     /// \param value
    00054     /// Input the name of the user.
    00055     ///
    00056     /// \return
    00057     /// Returns nothing
    00058     ///
    00059     FDO_API virtual void SetLockOwner(FdoString* value) = 0;
    00060
    00061     /// \brief
    00062     /// Executes the release lock command, returning an FdoILockConflictReader.
    00063     ///
    00064     /// \return
    00065     /// Returns a list of feature instances whose lock is owned by someone else.
    00066     ///
    00067     FDO_API virtual FdoILockConflictReader* Execute() = 0;
    00068 };
    00069 #endif
    00070
    00071

Please send us your comment about this page