FDO API Reference Feature Data Objects

LongTransactionPrivileges.h

Go to the documentation of this file.
00001 #ifndef _LONGTRANSACTIONPRIVILEGES_H_
00002 #define _LONGTRANSACTIONPRIVILEGES_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 /// \brief
00027 /// The FdoLongTransactionPrivileges enumeration defines the long transaction
00028 /// privilege flags.
00029 /// <param name="FdoLongTransactionPrivileges_Access">
00030 /// The access privilege is required for a user if the user needs to access
00031 /// a long transaction.
00032 /// </param>
00033 /// <param name="FdoLongTransactionPrivileges_Create">
00034 /// A user must have access and create privileges on the active long
00035 /// transaction if the user wants to create a new long transaction as a
00036 /// descendent of the active long transaction.
00037 /// </param>
00038 /// <param name="FdoLongTransactionPrivileges_Commit">
00039 /// A user must have access and commit privileges on a long transaction
00040 /// in order to commit it. In addition, the user needs access privilege to
00041 /// the long transaction's parent. The user also needs remove privilege on
00042 /// the long transaction to be committed if the operation to be executed
00043 /// is a commit and not a partial commit.
00044 /// </param>
00045 /// <param name="FdoLongTransactionPrivileges_Rollback">
00046 /// A user must have access and rollback privileges on a long transaction
00047 /// in order to roll it back. In addition, the user requires access
00048 /// privilege for each of the descendent versions involved in the operation. The user also requires the remove privilege for each of the versions involved in the operation if a rollback and not a partial rollback operation is executed.
00049 /// </param>
00050 /// <param name="FdoLongTransactionPrivileges_Remove">
00051 /// The long transaction privilege is required if the user should be allowed to remove the
00052 /// long transaction in the progress of a commit or roll back operation.
00053 /// </param>
00054 /// <param name="FdoLongTransactionPrivileges_Freeze">
00055 /// The user requires the access and freeze privileges on a long
00056 /// transaction for which the user wants to gain exclusive access to a
00057 /// long transaction.
00058 /// </param>
00059 enum FdoLongTransactionPrivileges
00060 {
00061     /// The access privilege is required for a user if the user needs to access
00062     /// a long transaction.
00063     FdoLongTransactionPrivileges_Access,
00064 
00065     /// A user must have access and create privileges on the active long
00066     /// transaction if the user wants to create a new long transaction as a
00067     /// descendent of the active long transaction.
00068     FdoLongTransactionPrivileges_Create,
00069 
00070     /// A user must have access and commit privileges on a long transaction
00071     /// in order to commit it. In addition, the user needs access privilege to
00072     /// the long transaction's parent. The user also needs remove privilege on
00073     /// the long transaction to be committed if the operation to be executed
00074     /// is a commit and not a partial commit.
00075     FdoLongTransactionPrivileges_Commit,
00076 
00077     /// A user must have access and rollback privileges on a long transaction
00078     /// in order to roll it back. In addition, the user requires access
00079     /// privilege for each of the descendent versions involved in the operation. The user also requires the remove privilege for each of the versions involved in the operation if a rollback and not a partial rollback operation is executed.
00080     FdoLongTransactionPrivileges_Rollback,
00081 
00082     /// The privilege is required if the user should be allowed to remove the
00083     /// long transaction in the progress of a commit or roll back operation.
00084     FdoLongTransactionPrivileges_Remove,
00085 
00086     /// The user requires the access and freeze privileges on a long
00087     /// transaction for which the user wants to gain exclusive access to a
00088     /// long transaction.
00089     FdoLongTransactionPrivileges_Freeze
00090 };
00091 #endif
00092 
00093 

Comments or suggestions? Send us feedback.