FDO API Reference Feature Data Objects

IChangeLongTransactionPrivileges.h

Go to the documentation of this file.
00001 #ifndef _ICHANGELONGTRANSACTIONPRIVILEGES_H_
00002 #define _ICHANGELONGTRANSACTIONPRIVILEGES_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/LongTransactionPrivilegeOperations.h>
00029 #include <Fdo/Commands/ICommand.h>
00030 
00031 /// \brief
00032 /// The FdoIChangeLongTransactionPrivileges interface defines the
00033 /// ChangeLongTransactionPrivileges command, which grants or revokes long
00034 /// transaction privileges for the named user. The ability to change the 
00035 /// privileges might be restricted by the datastore security if the long 
00036 /// transaction doesn’t belong to the user executing the command.
00037 class FdoIChangeLongTransactionPrivileges : public FdoICommand
00038 {
00039     friend class FdoIConnection;
00040 
00041 public:
00042     /// \brief
00043     /// Gets the name of the long transaction for which privileges should be
00044     /// changed.
00045     /// 
00046     /// \return
00047     /// Returns the name of the long transaction
00048     /// 
00049     FDO_API virtual FdoString* GetLongTransactionName() = 0;
00050 
00051     /// \brief
00052     /// Sets the name of the long transaction for which privileges should be
00053     /// changed.
00054     /// 
00055     /// \param value 
00056     /// Input the name of the long transaction
00057     /// 
00058     /// \return
00059     /// Returns nothing
00060     /// 
00061     FDO_API virtual void SetLongTransactionName(FdoString* value) = 0;
00062 
00063     /// \brief
00064     /// Gets the name of the user for which to grant or revoke privileges.
00065     /// 
00066     /// \return
00067     /// Returns the user name
00068     /// 
00069     FDO_API virtual FdoString* GetUserName() = 0;
00070     
00071     /// \brief
00072     /// Sets the name of the user for which to grant or revoke privileges.
00073     /// 
00074     /// \param value 
00075     /// Input the user name
00076     /// 
00077     /// \return
00078     /// Returns nothing
00079     /// 
00080     FDO_API virtual void SetUserName(FdoString* value) = 0;
00081 
00082     /// \brief
00083     /// Gets the privilege flags to grant or revoke.The returned value may be
00084     /// any combination of the values from the FdoLongTransactionPrivileges
00085     /// enumeration combined via a bit-wise or operation.
00086     /// 
00087     /// \return
00088     /// Returns the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration
00089     /// 
00090     FDO_API virtual FdoInt32 GetPrivileges() = 0;
00091 
00092     /// \brief
00093     /// Sets the privilege flags to grant or revoke. The privileges value may be
00094     /// any combination of the values from the FdoLongTransactionPrivileges
00095     /// enumeration combined via a bit-wise or operation.
00096     /// 
00097     /// \param value 
00098     /// Input the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration
00099     /// 
00100     /// \return
00101     /// Returns nothing
00102     /// 
00103     FDO_API virtual void SetPrivileges(FdoInt32 value) = 0;
00104 
00105     /// \brief
00106     /// Gets the operation to perform, grant, or revoke.
00107     /// 
00108     /// \return
00109     /// Returns the operation to perform
00110     /// 
00111     FDO_API virtual FdoLongTransactionPrivilegeOperations GetOperation() = 0;
00112 
00113     /// \brief
00114     /// Sets the operation to perform, grant, or revoke.
00115     /// 
00116     /// \param value 
00117     /// Input the operation to perform
00118     /// 
00119     /// \return
00120     /// Returns nothing
00121     /// 
00122     FDO_API virtual void SetOperation(FdoLongTransactionPrivilegeOperations value) = 0;
00123 
00124     /// \brief
00125     /// Executes the ChangeLongTransactionPrivilege command.
00126     /// 
00127     /// \return
00128     /// Returns nothing
00129     /// 
00130     FDO_API virtual void Execute() = 0;
00131 };
00132 #endif
00133 
00134 

Comments or suggestions? Send us feedback.