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

Generated on Tue Jun 10 17:20:21 2008 for Funambol C++ Client Library by  doxygen 1.5.2