blob: d496715c968f9082984fb974296dab4697ea18a9 (
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
* 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 <QString>
#include <QSharedPointer>
#include <Async/Async>
#include "query.h"
#include "applicationdomaintype.h"
class QAbstractItemModel;
namespace Akonadi2 {
/**
* Store interface used in the client API.
*/
class Store {
public:
static QString storageLocation();
static QByteArray resourceName(const QByteArray &instanceIdentifier);
enum Roles {
DomainObjectRole = Qt::UserRole + 1, //Must be the same as in ModelResult
ChildrenFetchedRole,
DomainObjectBaseRole
};
/**
* Asynchronusly load a dataset with tree structure information
*/
template <class DomainType>
static QSharedPointer<QAbstractItemModel> loadModel(Query query);
/**
* Create a new entity.
*/
template <class DomainType>
static KAsync::Job<void> create(const DomainType &domainObject);
/**
* Modify an entity.
*
* This includes moving etc. since these are also simple settings on a property.
*/
template <class DomainType>
static KAsync::Job<void> modify(const DomainType &domainObject);
/**
* Remove an entity.
*/
template <class DomainType>
static KAsync::Job<void> remove(const DomainType &domainObject);
/**
* Synchronize data to local cache.
*/
static KAsync::Job<void> synchronize(const Akonadi2::Query &query);
/**
* Shutdown resource.
*/
static KAsync::Job<void> shutdown(const QByteArray &resourceIdentifier);
/**
* Start resource.
*
* The resource is ready for operation once this command completes.
* This command is only necessary if a resource was shutdown previously,
* otherwise the resource process will automatically start as necessary.
*/
static KAsync::Job<void> start(const QByteArray &resourceIdentifier);
/**
* Flushes any pending messages to disk
*/
static KAsync::Job<void> flushMessageQueue(const QByteArrayList &resourceIdentifier);
/**
* Removes a resource from disk.
*/
static void removeFromDisk(const QByteArray &resourceIdentifier);
template <class DomainType>
static KAsync::Job<DomainType> fetchOne(const Akonadi2::Query &query);
template <class DomainType>
static KAsync::Job<QList<typename DomainType::Ptr> > fetchAll(const Akonadi2::Query &query);
template <class DomainType>
static KAsync::Job<QList<typename DomainType::Ptr> > fetch(const Akonadi2::Query &query, int minimumAmount = 0);
};
namespace Resources {
struct Inspection {
static Inspection PropertyInspection(const Akonadi2::ApplicationDomain::Entity &entity, const QByteArray &property, const QVariant &expectedValue)
{
Inspection inspection;
inspection.resourceIdentifier = entity.resourceInstanceIdentifier();
inspection.entityIdentifier = entity.identifier();
inspection.property = property;
inspection.expectedValue = expectedValue;
return inspection;
}
enum Type {
PropertyInspectionType
};
QByteArray resourceIdentifier;
QByteArray entityIdentifier;
QByteArray property;
QVariant expectedValue;
};
template <class DomainType>
KAsync::Job<void> inspect(const Inspection &inspectionCommand);
}
}
|
