src/include/common/examples/TestSyncSource.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_TEST_SYNC_SOURCE
00037 #define INCL_TEST_SYNC_SOURCE
00038 
00040 #include "base/fscapi.h"
00041 #include "spds/constants.h"
00042 #include "spds/SyncItem.h"
00043 #include "spds/SyncMap.h"
00044 #include "spds/SyncStatus.h"
00045 #include "spds/SyncSource.h"
00046 
00047 class  TestSyncSource : public SyncSource {
00048 
00049 public:
00050 
00057     TestSyncSource(const WCHAR* name, SyncSourceConfig *sc) ;
00058 
00059     // TestSyncSource
00060     ~TestSyncSource();
00061 
00062     /*
00063      * Return the first SyncItem of all.
00064      * It is used in case of slow or refresh sync
00065      * and retrieve the entire data source content.
00066      */
00067     SyncItem* getFirstItem();
00068 
00069     /*
00070      * Return the next SyncItem of all.
00071      * It is used in case of slow or refresh sync
00072      * and retrieve the entire data source content.
00073      */
00074     SyncItem* getNextItem();
00075 
00076     /*
00077      * Return the first SyncItem of new one. It is used in case of fast sync
00078      * and retrieve the new data source content.
00079      */
00080     SyncItem* getFirstNewItem();
00081 
00082     /*
00083      * Return the next SyncItem of new one. It is used in case of fast sync
00084      * and retrieve the new data source content.
00085      */
00086     SyncItem* getNextNewItem();
00087 
00088     /*
00089      * Return the first SyncItem of updated one. It is used in case of fast sync
00090      * and retrieve the new data source content.
00091      */
00092     SyncItem* getFirstUpdatedItem() ;
00093 
00094     /*
00095      * Return the next SyncItem of updated one. It is used in case of fast sync
00096      * and retrieve the new data source content.
00097      */
00098     SyncItem* getNextUpdatedItem();
00099 
00100     /*
00101      * Return the first SyncItem of updated one. It is used in case of fast sync
00102      * and retrieve the new data source content.
00103      */
00104     SyncItem* getFirstDeletedItem();
00105 
00106     /*
00107      * Return the next SyncItem of updated one. It is used in case of fast sync
00108      * and retrieve the new data source content.
00109      */
00110 
00111     SyncItem* getFirstItemKey();
00112 
00113     /*
00114      * Return the key of the next SyncItem of all.
00115      * It is used in case of refresh sync
00116      * and retrieve all the keys of the data source.
00117      */
00118     SyncItem* getNextItemKey();
00119 
00120 
00121     SyncItem* getNextDeletedItem();
00122 
00123     void setItemStatus(const WCHAR* key, int status);
00124 
00125     int addItem(SyncItem& item);
00126 
00127     int updateItem(SyncItem& item);
00128 
00129     int deleteItem(SyncItem& item);
00130 
00131     int beginSync();
00132 
00133     int endSync();
00134 
00135     ArrayElement* clone() { return 0; }
00136 };
00137 
00139 #endif

Generated on Mon Feb 4 09:50:47 2008 for Funambol Outlook Plug-in Library by  doxygen 1.5.2