itemsync.h

/*
    Copyright (c) 2007 Tobias Koenig <tokoe@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library 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 Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#ifndef AKONADI_ITEMSYNC_H
#define AKONADI_ITEMSYNC_H

#include "akonadi_export.h"

#include <akonadi/item.h>
#include <akonadi/job.h>

namespace Akonadi {

class Collection;
class ItemFetchScope;
class ItemSyncPrivate;

class AKONADI_EXPORT ItemSync : public Job
{
    Q_OBJECT

public:
    enum MergeMode
    {
        RIDMerge,
        GIDMerge
    };

    explicit ItemSync(const Collection &collection, QObject *parent = 0);

    ~ItemSync();

    void setFullSyncItems(const Item::List &items);

    void setTotalItems(int amount);

    void setStreamingEnabled(bool enable);

    void deliveryDone();

    void setIncrementalSyncItems(const Item::List &changedItems,
                                 const Item::List &removedItems);

    void setFetchScope(ItemFetchScope &fetchScope);

    ItemFetchScope &fetchScope();

    void rollback();

    enum TransactionMode {
        SingleTransaction, 
        MultipleTransactions, 
        NoTransaction 
    };

    void setTransactionMode(TransactionMode mode);

    int batchSize() const;

    void setBatchSize(int);

    void setDisableAutomaticDeliveryDone(bool disable);

    MergeMode mergeMode() const;

    void setMergeMode(MergeMode mergeMode);

Q_SIGNALS:
    void readyForNextBatch(int remainingBatchSize);

    void transactionCommitted();

protected:
    void doStart();
    void slotResult(KJob *job);

    AKONADI_DEPRECATED virtual bool updateItem(const Item &storedItem, Item &newItem);

private:
    //@cond PRIVATE
    Q_DECLARE_PRIVATE(ItemSync)
    ItemSyncPrivate *dummy; // for BC. KF5 TODO: REMOVE.

    Q_PRIVATE_SLOT(d_func(), void slotLocalListDone(KJob *))
    Q_PRIVATE_SLOT(d_func(), void slotLocalDeleteDone(KJob *))
    Q_PRIVATE_SLOT(d_func(), void slotLocalChangeDone(KJob *))
    Q_PRIVATE_SLOT(d_func(), void slotTransactionResult(KJob *))
    Q_PRIVATE_SLOT(d_func(), void slotItemsReceived(const Akonadi::Item::List &))
    //@endcond
};

}

#endif