summaryrefslogtreecommitdiffstats
path: root/common/facadeinterface.h
blob: 318abf3dda1a1058cdc1cd8f593857a4ae235d5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*
 * Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) version 3, or any
 * later version accepted by the membership of KDE e.V. (or its
 * successor approved by the membership of KDE e.V.), which shall
 * act as a proxy defined in Section 6 of version 3 of the license.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <Async/Async>
#include <QByteArray>
#include <QSharedPointer>
#include <QPair>
#include "applicationdomaintype.h"
#include "resultprovider.h"

namespace Akonadi2 {
class Query;

/**
 * Interface for the store facade.
 * 
 * All methods are synchronous.
 * Facades are stateful (they hold connections to resources and database).
 * 
 * TODO: would it make sense to split the write, read and notification parts? (we could potentially save some connections)
 */
template<class DomainType>
class StoreFacade {
public:
    virtual ~StoreFacade(){};
    QByteArray type() const { return ApplicationDomain::getTypeName<DomainType>(); }

    /**
     * Create an entity in the store.
     *
     * The job returns succefully once the task has been successfully placed in the queue
     */
    virtual KAsync::Job<void> create(const DomainType &domainObject) = 0;

    /**
     * Modify an entity in the store.
     *
     * The job returns succefully once the task has been successfully placed in the queue
     */
    virtual KAsync::Job<void> modify(const DomainType &domainObject) = 0;

    /**
     * Remove an entity from the store.
     *
     * The job returns succefully once the task has been successfully placed in the queue
     */
    virtual KAsync::Job<void> remove(const DomainType &domainObject) = 0;

    /**
     * Load entities from the store.
     */
    virtual QPair<KAsync::Job<void>, typename Akonadi2::ResultEmitter<typename DomainType::Ptr>::Ptr > load(const Query &query) = 0;
};

template<class DomainType>
class NullFacade : public StoreFacade<DomainType> {
public:
    virtual ~NullFacade(){};
    KAsync::Job<void> create(const DomainType &domainObject)
    {
        return KAsync::error<void>(-1, "Failed to create a facade");
    }

    KAsync::Job<void> modify(const DomainType &domainObject)
    {
        return KAsync::error<void>(-1, "Failed to create a facade");
    }

    KAsync::Job<void> remove(const DomainType &domainObject)
    {
        return KAsync::error<void>(-1, "Failed to create a facade");
    }

    QPair<KAsync::Job<void>, typename Akonadi2::ResultEmitter<typename DomainType::Ptr>::Ptr > load(const Query &query)
    {
        return qMakePair(KAsync::null<void>(), typename Akonadi2::ResultEmitter<typename DomainType::Ptr>::Ptr());
    }
};

}