| FDO .NET API Reference | Feature Data Objects |
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\mgIFeatureCommand.h" 00022 00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS 00024 public __gc class PropertyValueCollection; 00025 END_NAMESPACE_OSGEO_FDO_COMMANDS 00026 00027 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING 00028 public __gc __interface ILockConflictReader; 00029 END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING 00030 00031 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE 00032 00033 /// \ingroup (OSGeoFDOCommandsFeature) 00034 /// \interface OSGeo::FDO::Commands::Feature::IUpdate 00035 /// \brief 00036 /// The IUpdate interface defines the Update command, which modifies instances 00037 /// of a given class that match the specified criteria. Input to the update 00038 /// command includes the name of the class, the list of property name/value 00039 /// pairs to be updated, and the filter criteria by which to identify the 00040 /// instances to be updated. The filter may be specified either as text or as an 00041 /// expression tree (most likely produced by a query builder). The update 00042 /// command can update instances at global scope or nested within an 00043 /// object collection property. Instances at global scope are referred to simply 00044 /// by the class name. Instances at a nested scope (i.e., instances within an 00045 /// object collection property) are referred to by the containing class name, 00046 /// followed by a '.', followed by the object collection property name. 00047 public __gc __interface IUpdate : public NAMESPACE_OSGEO_FDO_COMMANDS::IFeatureCommand 00048 { 00049 public: 00050 /// \brief 00051 /// Gets the PropertyValueCollection that specifies the names and values of the 00052 /// properties to be updated. 00053 /// 00054 /// \return 00055 /// Returns the list of properties and their values. 00056 /// 00057 __property NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValueCollection* get_PropertyValues(); 00058 00059 /// \brief 00060 /// Executes the update command and returns the number of modified 00061 /// instances. 00062 /// 00063 /// \return 00064 /// Returns nothing 00065 /// 00066 System::Int32 Execute(); 00067 00068 /// \brief 00069 /// Updating objects might result in lock conflicts if objects 00070 /// to be updated are not exclusively locked for the user attempting to 00071 /// update the object. If objects to be updated are not exclusively locked for the 00072 /// user attempting to update the object, a lock conflict report is generated. 00073 /// This function returns a lock conflict reader providing 00074 /// access to the list of lock conflicts that occurred during the execution 00075 /// of the update operation. 00076 /// 00077 /// \return 00078 /// Returns a lock conflict reader. 00079 /// 00080 __property NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING::ILockConflictReader* get_LockConflicts(); 00081 }; 00082 00083 END_NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE 00084 00085
| Comments or suggestions? Send us feedback. |