fileobjectsyncsource.h

funambol windows mobile plugin source code, the source code is taken from the funambol site

/*
 * Copyright (C) 2003-2007 Funambol, Inc
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY, TITLE, NONINFRINGEMENT 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_FILEOBJECT_SYNC_SOURCE
#define INCL_FILEOBJECT_SYNC_SOURCE

#include "base/fscapi.h"
#include "spds/constants.h"
#include "spds/SyncItem.h"
#include "spds/SyncMap.h"
#include "spds/SyncStatus.h"
#include "spds/SyncSource.h"
#include "pim/Container.h"
#include "pim/Utils.h"


class FileObjectSyncSource : public SyncSource {

private:
    /*
    * Is the type of the sync source
    * type could be
    * 10: contact
    * It must be set by the specific sync source
    *
    */
    SourceType type;

protected:
    /*
    * It is the path in which the application is.
    */
    wchar_t* path;
    /*
    * It is the dir in which the notes or the files are and that are to be synced.
    */
    wchar_t* dir;

    /*
    * The container object that contain all, new, update and deleted items
    */
    Container* c;

    // The copy is protected
    FileObjectSyncSource(SyncSource& s);

public:

    char friendlyName[64];
    int newFromServer;
    int updatedFromServer;
    int deletedFromServer;
    /*
     * Must be implemented.
     */
    virtual void setSourceType(SourceType t) = 0;

    /**
     * set/get function for type
     */
    void setType(SourceType t);
    SourceType getType();

    void setPath(const wchar_t* p);
    const wchar_t* getPath();

    void setDir(const wchar_t* p);
    const wchar_t* getDir();


    /**
     * Constructor: create a SyncSource with the specified name
     *
     * @param name - the name of the SyncSource
     */
    FileObjectSyncSource(const wchar_t* name, SyncSourceConfig* sc);

    // TestSyncSource
    virtual ~FileObjectSyncSource();

    /*
     * Return the first SyncItem of all.
     * It is used in case of slow or refresh sync
     * and retrieve the entire data source content.
     */
    SyncItem* getFirstItem();

    /*
     * Return the next SyncItem of all.
     * It is used in case of slow or refresh sync
     * and retrieve the entire data source content.
     */
    SyncItem* getNextItem();

    /*
     * Return the first SyncItem of new one. It is used in case of fast sync
     * and retrieve the new data source content.
     */
    SyncItem* getFirstNewItem();

    /*
     * Return the next SyncItem of new one. It is used in case of fast sync
     * and retrieve the new data source content.
     */
    SyncItem* getNextNewItem();

    /*
     * Return the first SyncItem of updated one. It is used in case of fast sync
     * and retrieve the new data source content.
     */
    SyncItem* getFirstUpdatedItem() ;

    /*
     * Return the next SyncItem of updated one. It is used in case of fast sync
     * and retrieve the new data source content.
     */
    SyncItem* getNextUpdatedItem();

    /*
     * Return the first SyncItem of updated one. It is used in case of fast sync
     * and retrieve the new data source content.
     */
    SyncItem* getFirstDeletedItem();

    /*
     * Return the next SyncItem of updated one. It is used in case of fast sync
     * and retrieve the new data source content.
     */

    SyncItem* getNextDeletedItem();

    void setItemStatus(const wchar_t* key, int status);

    int addItem(SyncItem& item);

    int updateItem(SyncItem& item);

    int deleteItem(SyncItem& item);

    int beginSync();

    int endSync();

    void assign(FileObjectSyncSource& s);

    SyncItem* getFirstItemKey();

    SyncItem* getNextItemKey();

};

#endif