FDO API Reference | Feature Data Objects |
00001 #ifndef _ILONGTRANSACTIONCONFLICTDIRECTIVEENUMERATOR_H_ 00002 #define _ILONGTRANSACTIONCONFLICTDIRECTIVEENUMERATOR_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/LongTransaction/LongTransactionConflictResolution.h> 00028 00029 /// \brief 00030 /// The FdoILongTransactionConflictDirective interface is used to specify how 00031 /// conflict should be resolved for a particular object. 00032 class FdoILongTransactionConflictDirectiveEnumerator : public FdoIDisposable 00033 { 00034 public: 00035 /// \brief 00036 /// Gets the class name of the current feature in conflict. 00037 /// 00038 /// \return 00039 /// Returns the class name 00040 /// 00041 FDO_API virtual FdoString* GetFeatureClassName() = 0; 00042 00043 /// \brief 00044 /// Returns FdoPropertyValueCollection containing the property values that 00045 /// uniquely identify the current feature in conflict. 00046 /// 00047 /// \return 00048 /// Returns FdoPropertyValueCollection 00049 /// 00050 FDO_API virtual FdoPropertyValueCollection* GetIdentity() = 0; 00051 00052 /// \brief 00053 /// Gets the FdoLongTransactionConflictResolution value to use for the current 00054 /// feature. The default value is FdoLongTransactionConflictResolution_Child. 00055 /// 00056 /// \return 00057 /// Returns FdoLongTransactionConflictResolution value 00058 /// 00059 FDO_API virtual FdoLongTransactionConflictResolution GetResolution() = 0; 00060 00061 /// \brief 00062 /// Sets the FdoLongTransactionConflictResolution value to use for the current 00063 /// feature. The default value is FdoLongTransactionConflictResolution_Child. 00064 /// 00065 /// \param value 00066 /// Input the FdoLongTransactionConflictResolution value 00067 /// 00068 /// \return 00069 /// Returns nothing 00070 /// 00071 FDO_API virtual void SetResolution(FdoLongTransactionConflictResolution value) = 0; 00072 00073 /// \brief 00074 /// Returns the number of conflicts reported by this enumerator. 00075 /// 00076 /// \return 00077 /// Returns the number of conflicts 00078 /// 00079 FDO_API virtual FdoInt32 GetCount() = 0; 00080 00081 /// \brief 00082 /// Advances the enumerator to the next conflict. The default position of the 00083 /// enumerator is prior to the first item. Thus, you must call ReadNext 00084 /// to begin accessing any data. ReadNext returns true until the end of the 00085 /// directives is reached. After the end of the directives is passed, 00086 /// subsequent calls to ReadNext return false until Reset is called. 00087 /// 00088 /// \return 00089 /// Returns True until the end of the 00090 /// directives is reached 00091 /// 00092 FDO_API virtual bool ReadNext() = 0; 00093 00094 /// \brief 00095 /// Sets the enumerator to its initial position, which is before the first 00096 /// conflict. 00097 /// 00098 /// \return 00099 /// Returns nothing 00100 /// 00101 FDO_API virtual void Reset() = 0; 00102 }; 00103 #endif 00104 00105
Comments or suggestions? Send us feedback. |