00001 #ifndef FdoIBulkCopyProgressArgs_H
00002 #define FdoIBulkCopyProgressArgs_H
00003
00004 /*
00005 * (C) Copyright 2006 by Autodesk, Inc. All Rights Reserved.
00006 *
00007 * By using this code, you are agreeing to the terms and conditions of
00008 * the License Agreement included in the documentation for this code.
00009 *
00010 * AUTODESK MAKES NO WARRANTIES, EXPRESS OR IMPLIED, AS TO THE
00011 * CORRECTNESS OF THIS CODE OR ANY DERIVATIVE WORKS WHICH INCORPORATE
00012 * IT. AUTODESK PROVIDES THE CODE ON AN "AS-IS" BASIS AND EXPLICITLY
00013 * DISCLAIMS ANY LIABILITY, INCLUDING CONSEQUENTIAL AND INCIDENTAL
00014 * DAMAGES FOR ERRORS, OMISSIONS, AND OTHER PROBLEMS IN THE CODE.
00015 *
00016 * Use, duplication, or disclosure by the U.S. Government is subject
00017 * to restrictions set forth in FAR 52.227-19 (Commercial Computer
00018 * Software Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
00019 * (Rights in Technical Data and Computer Software), as applicable.
00020 *
00021 */
00022 #include <Fdo.h>
00023 #include <Common/FdoTypes.h>
00024 #include <Utilities/FdoBulkCopy.h>
00025
00026 #include <Utilities/BulkCopy/FdoBulkCopyProgressStatus.h>
00027
00028 /// \brief
00029 /// The FdoIBulkCopyProgressArgs class represents the bulk copy progress reporting argument class.
00030 class FdoIBulkCopyProgressArgs : public FdoIDisposable
00031 {
00032 public:
00033 /// \brief
00034 /// Returned the number of object read from the source datastore.
00035 ///
00036 /// \return
00037 /// Returns the number of objects read.
00038 ///
00039 FDOBULKCOPY_API virtual FdoInt32 GetNumberRead() = 0;
00040
00041 /// \brief
00042 /// Returned the number of object successfully insert in the target datastore.
00043 ///
00044 /// \return
00045 /// Returns the number objects inserted.
00046 ///
00047 FDOBULKCOPY_API virtual FdoInt32 GetNumberInserted() = 0;
00048
00049 /// \brief
00050 /// Change the status value in order to continue or interrupt current bulk copy operation.
00051 ///
00052 /// \return
00053 /// Returns nothing.
00054 ///
00055 FDOBULKCOPY_API virtual void SetStatus(FdoBulkCopyProgressStatus status) = 0;
00056
00057 };
00058 #endif