collectionfetchjob.h

/*
    Copyright (c) 2006 - 2007 Volker Krause <[email protected]>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#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)
};

}

#endif