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_ERROR_HANDLER 00037 #define INCL_ERROR_HANDLER 00038 /** @cond DEV */ 00039 00040 #include "base/fscapi.h" 00041 #include "base/globalsdef.h" 00042 00043 BEGIN_NAMESPACE 00044 00045 class ErrorHandler { 00046 00047 public: 00048 ErrorHandler(); 00049 virtual ~ErrorHandler(); 00050 00051 /** 00052 * @brief Handle a warning event. 00053 * The sync engine continues the operations. 00054 * 00055 * @param code An integer code defining the warning 00056 * @param msg A message explaining the warning 00057 * 00058 * @return None. 00059 */ 00060 virtual void warning(int code, const char* msg) = 0; 00061 00062 /** 00063 * @brief Handle an error condition 00064 * The sync engine may continue or not the operations, 00065 * depending on client response. 00066 * 00067 * @param code An integer code defining the error 00068 * @param msg A message explaining the error 00069 * 00070 * @return true if the synchronization must be stopped. 00071 */ 00072 virtual bool error(int code, const char* msg) = 0; 00073 00074 /** 00075 * @brief Handle a fatal error 00076 * The synchronization process cannot be 00077 * completed. 00078 * 00079 * @param code An integer code defining the error 00080 * @param msg A message explaining the error 00081 * 00082 * @return None 00083 */ 00084 virtual void fatalError(int code, const char* msg) = 0; 00085 00086 /** 00087 * @brief clone the error handler object. 00088 * 00089 * @return None 00090 */ 00091 virtual ErrorHandler* clone() = 0; 00092 00093 /** 00094 * @brief Get last error 00095 * 00096 * @return Return the code of the last error occurred. 00097 */ 00098 int getLastError(); 00099 00100 /** 00101 * @brief Reset last error attribute to the initial value 00102 * 00103 * @return Return the code of the previous value of last error. 00104 */ 00105 int resetError(); 00106 00107 private: 00108 int lastError; 00109 }; 00110 00111 00112 END_NAMESPACE 00113 00114 /** @endcond */ 00115 #endif 00116