collectionfetchjob.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_COLLECTIONFETCHJOB_H
#define AKONADI_COLLECTIONFETCHJOB_H

#include "akonadicore_export.h"
#include "collection.h"
#include "job.h"

namespace Akonadi
{

class CollectionFetchScope;
class CollectionFetchJobPrivate;

class AKONADICORE_EXPORT CollectionFetchJob : public Job
{
    Q_OBJECT

public:
    enum Type {
        Base,       
        FirstLevel, 
        Recursive,  
        NonOverlappingRoots  
    };

    explicit CollectionFetchJob(const Collection &collection, Type type = FirstLevel, QObject *parent = nullptr);

    explicit CollectionFetchJob(const Collection::List &collections, QObject *parent = nullptr);

    CollectionFetchJob(const Collection::List &collections, Type type, QObject *parent = nullptr);

    explicit CollectionFetchJob(const QList<Collection::Id> &collections, Type type = Base, QObject *parent = nullptr);

    ~CollectionFetchJob() override;

    Q_REQUIRED_RESULT Collection::List collections() const;

    void setFetchScope(const CollectionFetchScope &fetchScope);

    Q_REQUIRED_RESULT CollectionFetchScope &fetchScope();

Q_SIGNALS:
    void collectionsReceived(const Akonadi::Collection::List &collections);

protected:
    void doStart() override;
    bool doHandleResponse(qint64 tag, const Protocol::CommandPtr &response) override;

protected Q_SLOTS:
    //@cond PRIVATE
    void slotResult(KJob *job) override;
    //@endcond

private:
    Q_DECLARE_PRIVATE(CollectionFetchJob)

    //@cond PRIVATE
    Q_PRIVATE_SLOT(d_func(), void timeout())
    Q_PRIVATE_SLOT(d_func(), void subJobCollectionReceived(const Akonadi::Collection::List &))
    //@endcond
};

}

#endif