FDO .NET API Reference Feature Data Objects

mgILTConflictDirectiveEnumerator.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 #include "FDO\Commands\LongTransaction\mgLongTransactionConflictResolution.h"
00022 
00023 class PropertyValueCollection;
00024 class ILongTransactionConflictDirectiveEnumerator;
00025 
00026 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS
00027 public __gc class PropertyValueCollection;
00028 END_NAMESPACE_OSGEO_FDO_COMMANDS
00029 
00030 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00031 
00032 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00033 /// \interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionConflictDirectiveEnumerator
00034 /// \brief
00035 /// The ILongTransactionConflictDirective interface is used to specify how
00036 /// conflict should be resolved for a particular object.
00037 public __gc __interface ILongTransactionConflictDirectiveEnumerator : public System::IDisposable
00038 {
00039 public:
00040     /// \brief
00041     /// Gets the class name of the current feature in conflict.
00042     /// 
00043     /// \return
00044     /// Returns the class name
00045     /// 
00046     __property System::String* get_FeatureClassName();
00047 
00048     /// \brief
00049     /// Returns PropertyValueCollection containing the property values that
00050     /// uniquely identify the current feature in conflict.
00051     /// 
00052     /// \return
00053     /// Returns PropertyValueCollection
00054     /// 
00055     __property NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValueCollection* get_Identity();
00056 
00057     /// \brief
00058     /// Gets the LongTransactionConflictResolution value to use for the current
00059     /// feature. The default value is LongTransactionConflictResolution_Child.
00060     /// 
00061     /// \return
00062     /// Returns LongTransactionConflictResolution value
00063     /// 
00064     __property NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::LongTransactionConflictResolution get_Resolution();
00065 
00066     /// \brief
00067     /// Sets the LongTransactionConflictResolution value to use for the current
00068     /// feature. The default value is LongTransactionConflictResolution_Child.
00069     /// 
00070     /// \param value 
00071     /// Input the LongTransactionConflictResolution value
00072     /// 
00073     /// \return
00074     /// Returns nothing
00075     /// 
00076     __property System::Void set_Resolution(NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::LongTransactionConflictResolution value);
00077 
00078     /// \brief
00079     /// Returns the number of conflicts reported by this enumerator.
00080     /// 
00081     /// \return
00082     /// Returns the number of conflicts
00083     /// 
00084     __property System::Int32 get_Count();
00085 
00086     /// \brief
00087     /// Advances the enumerator to the next conflict. The default position of the
00088     /// enumerator is prior to the first item. Thus, you must call ReadNext
00089     /// to begin accessing any data. ReadNext returns true until the end of the
00090     /// directives is reached. After the end of the directives is passed,
00091     /// subsequent calls to ReadNext return false until Reset is called.
00092     /// 
00093     /// \return
00094     /// Returns True until the end of the
00095     /// directives is reached
00096     /// 
00097     System::Boolean ReadNext();
00098 
00099     /// \brief
00100     /// Sets the enumerator to its initial position, which is before the first
00101     /// conflict.
00102     /// 
00103     /// \return
00104     /// Returns nothing
00105     /// 
00106     System::Void Reset();
00107 };
00108 
00109 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00110 
00111 

Comments or suggestions? Send us feedback.