FDO .NET API Reference Feature Data Objects

mgILTPrivilegeReaderImp.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\mgILongTransactionPrivilegeReader.h"
00022 
00023 class FdoILongTransactionPrivilegeReader;
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00026 
00027 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00028 /// \brief
00029 /// The ILongTransactionPrivilegeReaderImp class is a concrete
00030 /// implementation of ILongTransactionPrivilegeReader.
00031 /// The ILongTransactionPrivilegeReader interface provides forward only,
00032 /// read-only functionality for enumerating long transaction privileges.
00033 /// A reference to an FdoILongTransactionPrivilegeReader is returned from
00034 /// the GetLongTransactionPrivileges command. The initial position of
00035 /// the ILongTransactionPrivilegeReader is prior to the first item.
00036 /// Thus, you must call ReadNext to begin accessing any data.
00037 private __gc class ILongTransactionPrivilegeReaderImp : public NAMESPACE_OSGEO_RUNTIME::Disposable, 
00038                                                         public NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionPrivilegeReader
00039 {
00040 public:
00041     /// \brief
00042     /// Gets the name of the user currently being read.
00043     /// 
00044     /// \return
00045     /// Returns the user name
00046     /// 
00047     System::String* GetUsername();
00048 
00049     /// \brief
00050     /// Gets the privileges granted to the user currently being read. The
00051     /// returned value may be any combination of the values from the
00052     /// LongTransactionPrivileges enumeration combined via a bit-wise or
00053     /// operation.
00054     /// 
00055     /// \return
00056     /// Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration
00057     /// 
00058     System::Int32 GetPrivileges();
00059 
00060     /// \brief
00061     /// Advances the reader to the next item. The default position of the
00062     /// reader is prior to the first item. Therefore you must call ReadNext
00063     /// to begin accessing any data.
00064     /// 
00065     /// \return
00066     /// Returns true if there is a next item
00067     /// 
00068     System::Boolean ReadNext();
00069 
00070     /// \brief
00071     /// Closes the ILongTransactionPrivilegesReader object, freeing any
00072     /// resources it may be holding.
00073     /// 
00074     /// \return
00075     /// Returns nothing
00076     /// 
00077     System::Void Close();
00078 
00079 public private:
00080     ILongTransactionPrivilegeReaderImp(System::IntPtr unmanaged, System::Boolean autoDelete) : NAMESPACE_OSGEO_RUNTIME::Disposable(unmanaged, autoDelete)
00081     {
00082 
00083     }
00084 
00085     inline FdoILongTransactionPrivilegeReader* GetImpObj();
00086 
00087 /// \cond DOXYGEN-IGNORE
00088 protected:
00089     __sealed System::Void ReleaseUnmanagedObject();
00090 /// \endcond
00091 
00092 };
00093 
00094 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00095 
00096 

Comments or suggestions? Send us feedback.