itemfetchjob.h

/*
    Copyright (c) 2006 - 2007 Volker Krause <vkrause@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_ITEMFETCHJOB_H
#define AKONADI_ITEMFETCHJOB_H

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

namespace Akonadi {

class Collection;
class ItemFetchJobPrivate;
class ItemFetchScope;

class AKONADI_EXPORT ItemFetchJob : public Job
{
    Q_OBJECT
    Q_FLAGS(DeliveryOptions)
public:
    explicit ItemFetchJob(const Collection &collection, QObject *parent = 0);

    explicit ItemFetchJob(const Item &item, QObject *parent = 0);

    explicit ItemFetchJob(const Item::List &items, QObject *parent = 0);

    explicit ItemFetchJob(const QList<Item::Id> &items, QObject *parent = 0);


    explicit ItemFetchJob(const Tag &tag, QObject *parent = 0);

    virtual ~ItemFetchJob();

    Item::List items() const;

    void clearItems();

    void setFetchScope(ItemFetchScope &fetchScope);   // KDE5: remove

    void setFetchScope(const ItemFetchScope &fetchScope);

    ItemFetchScope &fetchScope();

    void setCollection(const Collection &collection);

    enum DeliveryOption {
        ItemGetter = 0x1,            
        EmitItemsIndividually = 0x2, 
        EmitItemsInBatches = 0x4,    
        Default = ItemGetter | EmitItemsInBatches
    };
    Q_DECLARE_FLAGS(DeliveryOptions, DeliveryOption)

    
    void setDeliveryOption(DeliveryOptions options);

    DeliveryOptions deliveryOptions() const;

    int count() const;

Q_SIGNALS:
    void itemsReceived(const Akonadi::Item::List &items);

protected:
    virtual void doStart();
    virtual void doHandleResponse(const QByteArray &tag, const QByteArray &data);

private:
    Q_DECLARE_PRIVATE(ItemFetchJob)

    //@cond PRIVATE
    Q_PRIVATE_SLOT(d_func(), void timeout())
    //@endcond
};

}

Q_DECLARE_OPERATORS_FOR_FLAGS(Akonadi::ItemFetchJob::DeliveryOptions)

#endif