itemfetchscope.h

/*
    SPDX-FileCopyrightText: 2008 Kevin Krammer <[email protected]>

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

#ifndef ITEMFETCHSCOPE_H
#define ITEMFETCHSCOPE_H

#include "akonadicore_export.h"

#include <QMetaType>
#include <QSet>
#include <QSharedDataPointer>
#include <QDateTime>

template <typename T> class QSet;

namespace Akonadi
{

class ItemFetchScopePrivate;
class TagFetchScope;

class AKONADICORE_EXPORT ItemFetchScope
{
public:
    enum AncestorRetrieval {
        None, 
        Parent, 
        All 
    };

    ItemFetchScope();

    ItemFetchScope(const ItemFetchScope &other);

    ~ItemFetchScope();

    ItemFetchScope &operator=(const ItemFetchScope &other);

    Q_REQUIRED_RESULT QSet<QByteArray> payloadParts() const;

    void fetchPayloadPart(const QByteArray &part, bool fetch = true);

    Q_REQUIRED_RESULT bool fullPayload() const;

    void fetchFullPayload(bool fetch = true);

    Q_REQUIRED_RESULT QSet<QByteArray> attributes() const;

    void fetchAttribute(const QByteArray &type, bool fetch = true);

    template <typename T> inline void fetchAttribute(bool fetch = true)
    {
        T dummy;
        fetchAttribute(dummy.type(), fetch);
    }

    Q_REQUIRED_RESULT bool allAttributes() const;

    void fetchAllAttributes(bool fetch = true);

    Q_REQUIRED_RESULT bool cacheOnly() const;

    void setCacheOnly(bool cacheOnly);

    void setCheckForCachedPayloadPartsOnly(bool check = true);

    Q_REQUIRED_RESULT bool checkForCachedPayloadPartsOnly() const;

    void setAncestorRetrieval(AncestorRetrieval ancestorDepth);

    Q_REQUIRED_RESULT AncestorRetrieval ancestorRetrieval() const;

    void setFetchModificationTime(bool retrieveMtime);

    Q_REQUIRED_RESULT bool fetchModificationTime() const;

    void setFetchGid(bool retrieveGID);

    Q_REQUIRED_RESULT bool fetchGid() const;

    void setIgnoreRetrievalErrors(bool enabled);

    Q_REQUIRED_RESULT bool ignoreRetrievalErrors() const;

    Q_REQUIRED_RESULT bool isEmpty() const;

    void setFetchChangedSince(const QDateTime &changedSince);

    Q_REQUIRED_RESULT QDateTime fetchChangedSince() const;

    void setFetchRemoteIdentification(bool retrieveRid);

    Q_REQUIRED_RESULT bool fetchRemoteIdentification() const;

    void setFetchTags(bool fetchTags);

    Q_REQUIRED_RESULT bool fetchTags() const;

    void setTagFetchScope(const TagFetchScope &fetchScope);

    TagFetchScope &tagFetchScope();

    Q_REQUIRED_RESULT TagFetchScope tagFetchScope() const;

    void setFetchVirtualReferences(bool fetchVRefs);

    Q_REQUIRED_RESULT bool fetchVirtualReferences() const;

    void setFetchRelations(bool fetchRelations);

    Q_REQUIRED_RESULT bool fetchRelations() const;

private:
    //@cond PRIVATE
    QSharedDataPointer<ItemFetchScopePrivate> d;
    //@endcond
};

}

Q_DECLARE_METATYPE(Akonadi::ItemFetchScope)

#endif