FDO .NET API Reference Feature Data Objects

mgICreateLongTransactionCheckpoint.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\mgICommand.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00024 
00025 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00026 /// \interface OSGeo::FDO::Commands::LongTransaction::ICreateLongTransactionCheckpoint
00027 /// \brief
00028 /// The ICreateLongTransactionCheckpoint interface defines the
00029 /// CreateLongTransactionCheckpoint command, which allows the user to create a
00030 /// checkpoint for any long transaction to which the user has the access privileges.
00031 public __gc __interface ICreateLongTransactionCheckpoint : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00032 {
00033 public:
00034     /// \brief
00035     /// Gets the name of the long transaction for which a checkpoint should
00036     /// be created.
00037     /// 
00038     /// \return
00039     /// Returns the long transaction name
00040     /// 
00041     __property System::String* get_LongTransactionName();
00042 
00043     /// \brief
00044     /// Sets the name of the long transaction for which a checkpoint should
00045     /// be created.
00046     /// 
00047     /// \param value 
00048     /// Input the name of the long transaction
00049     /// 
00050     /// \return
00051     /// Returns nothing
00052     /// 
00053     __property System::Void set_LongTransactionName(System::String* value);
00054 
00055     /// \brief
00056     /// Gets the name of the checkpoint to be created for the named long
00057     /// transaction.
00058     /// 
00059     /// \return
00060     /// Returns the checkpoint name
00061     /// 
00062     __property System::String* get_CheckpointName();
00063 
00064     /// \brief
00065     /// Sets the name of the checkpoint to be created for the named long
00066     /// transaction.
00067     /// 
00068     /// \param value 
00069     /// Input the checkpoint name
00070     /// 
00071     /// \return
00072     /// Returns nothing
00073     /// 
00074     __property System::Void set_CheckpointName(System::String* value);
00075 
00076     /// \brief
00077     /// Gets the description of the checkpoint to be created for the named
00078     /// long transaction.
00079     /// 
00080     /// \return
00081     /// Returns the description of the checkpoint
00082     /// 
00083     __property System::String* get_CheckpointDescription();
00084 
00085     /// \brief
00086     /// Sets the description of the checkpoint to be created for the named
00087     /// long transaction.
00088     /// 
00089     /// \param value 
00090     /// Input the description of the checkpoint
00091     /// 
00092     /// \return
00093     /// Returns nothing
00094     /// 
00095     __property System::Void set_CheckpointDescription(System::String* value);
00096 
00097     /// \brief
00098     /// Executes the CreateLongTransactionCheckpoint command.
00099     /// 
00100     /// \return
00101     /// Returns nothing
00102     /// 
00103     System::Void Execute();
00104 };
00105 
00106 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00107 
00108 

Comments or suggestions? Send us feedback.