src/include/common/spds/SyncSource.h

/*
 * Copyright (C) 2003-2007 Funambol
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef INCL_SYNC_SOURCE
#define INCL_SYNC_SOURCE

#include "base/fscapi.h"
#include "base/ErrorHandler.h"
#include "base/util/ArrayElement.h"
#include "filter/SourceFilter.h"
#include "spds/constants.h"
#include "spds/SyncItem.h"
#include "spds/SyncStatus.h"
#include "spds/SyncSourceConfig.h"
#include "spds/SyncSourceReport.h"

class SyncSource : public ArrayElement {

private:
    SyncMode      syncMode;
    unsigned long lastSync;
    unsigned long nextSync;
    WCHAR*      name;

    char next[DIM_ANCHOR];
    char last[DIM_ANCHOR];

    //ErrorHandler* errorHandler;

    SourceFilter* filter;

protected:
    SyncSourceConfig& config;
    SyncSourceReport* report;

    void assign(SyncSource& s);
    
public:

    SyncSource(const WCHAR* name, SyncSourceConfig* sc) EXTRA_SECTION_01;

    // Destructor
    virtual ~SyncSource() EXTRA_SECTION_01;

    const WCHAR *getName() EXTRA_SECTION_01;

    /**********************************************************
     * Most of the configurable properties are read
     * by the client library from the config (in
     * SyncClient::setDMConfig()) and then copied into the
     * sync source.
     *
     * These properties are stored in a local copy which will not be
     * written back into the permanent config, with a few exceptions:
     * properties related to mananging sync sessions like lastAnchor
     * are written back into the config by the library afer a
     * successful synchronization.
     *
     * A client developer is not required to modify these calls,
     * but he can use and/or update the properties before the
     * synchronization starts.
     *********************************************************/

    const SyncSourceConfig& getConfig() const EXTRA_SECTION_01 {
        return config;
    }
    SyncSourceConfig& getConfig() EXTRA_SECTION_01 {
        return config;
    }


    SyncSourceReport* getReport() EXTRA_SECTION_01;

    void setReport(SyncSourceReport* sr) EXTRA_SECTION_01;

    SyncMode getPreferredSyncMode() EXTRA_SECTION_01;
    void setPreferredSyncMode(SyncMode syncMode) EXTRA_SECTION_01;

    SyncMode getSyncMode() EXTRA_SECTION_01;
    void setSyncMode(SyncMode syncMode) EXTRA_SECTION_01;

    unsigned long getLastSync() EXTRA_SECTION_01;
    void setLastSync(unsigned long timestamp) EXTRA_SECTION_01;

    unsigned long getNextSync() EXTRA_SECTION_01;
    void setNextSync(unsigned long timestamp) EXTRA_SECTION_01;

    void setLastAnchor(const char*  last) EXTRA_SECTION_01;
    const char*  getLastAnchor() EXTRA_SECTION_01;

    const char*  getNextAnchor() EXTRA_SECTION_01;
    void setNextAnchor(const char*  next) EXTRA_SECTION_01;
    
    SourceFilter* getFilter();

    void setFilter(SourceFilter* f);

    /******************************************************
     * The following methods are virtual because a
     * derived SyncSource is expected to override or
     * implement them. Only the pure virtual methods
     * really have to be implemented, the others have
     * reasonable defaults.
     *****************************************************/
    
    virtual int beginSync() EXTRA_SECTION_01;
    
    virtual int endSync() EXTRA_SECTION_01;

    virtual void setItemStatus(const WCHAR* key, int status) = 0 EXTRA_SECTION_01;

    virtual SyncItem* getFirstItemKey() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getNextItemKey() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getFirstItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getNextItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getFirstNewItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getNextNewItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getFirstUpdatedItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getNextUpdatedItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getFirstDeletedItem() = 0 EXTRA_SECTION_01;

    virtual SyncItem* getNextDeletedItem() = 0 EXTRA_SECTION_01;

    virtual int addItem(SyncItem& item) = 0 EXTRA_SECTION_01;

    virtual int updateItem(SyncItem& item) = 0 EXTRA_SECTION_01;

    virtual int deleteItem(SyncItem& item) = 0 EXTRA_SECTION_01;

    virtual ArrayElement* clone() EXTRA_SECTION_01 = 0;
};

#endif

---