src/include/common/spds/ItemReport.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_ITEMREPORT
00037 #define INCL_ITEMREPORT
00038 
00040 #include "base/fscapi.h"
00041 #include "base/Log.h"
00042 #include "base/util/utils.h"
00043 #include "base/globalsdef.h"
00044 
00045 BEGIN_NAMESPACE
00046 
00047 
00048 /*
00049  * ----------------- ItemReport Class ------------------------
00050  * temReport class rapresents the result information on a
00051  * single item synchronized, such as the luid of the item
00052  * and its status code (200/201/500...)
00053  */
00054 class ItemReport : public ArrayElement {
00055 
00056 private:
00057 
00058     // The status code of the operation executed.
00059     int  status;
00060 
00061     // The LUID of item.
00062     WCHAR* luid;
00063 
00064     // The message associated to the status. It can be referred to the whole sync process if the error
00065     // is on the sync header (for example a 506 status code in the sync header) or to a single item as a
00066     // 500 status code on an inserting item.
00067     // in the first case the last error message and code must be set. In the other cases only the status
00068     //
00069     WCHAR* statusMessage;
00070 
00071 
00072     /*
00073      * Assign this object with the given ItemReport
00074      * @param ir: the ItemReport object
00075      */
00076     void assign(const ItemReport& ir);
00077 
00078 
00079 public:
00080 
00081     ItemReport();
00082     ItemReport(ItemReport& ir);
00083     ItemReport(const WCHAR* luid, const int statusCode, const WCHAR* statusMess);
00084     virtual ~ItemReport();
00085 
00086     const WCHAR* getId() const;
00087     void setId(const WCHAR* v);
00088 
00089     const int getStatus() const;
00090     void setStatus(const int v);
00091 
00092     const WCHAR* getStatusMessage() const;
00093     void setStatusMessage(const WCHAR* v);
00094 
00095     ArrayElement* clone();
00096 
00097     /*
00098      * Assign operator
00099      */
00100     ItemReport& operator = (const ItemReport& ir) {
00101         assign(ir);
00102         return *this;
00103     }
00104 };
00105 
00106 
00107 END_NAMESPACE
00108 
00110 #endif
00111 

Generated on Fri Jul 25 15:04:15 2008 for Funambol C++ Client Library by  doxygen 1.5.1