blob: 5da2efeb12afa70613228fad701b31a3324470d6 (
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtOrganizer module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qorganizeritemfetchrequest.h"
#include "qorganizeritemrequests_p.h"
QT_BEGIN_NAMESPACE_ORGANIZER
/*!
\class QOrganizerItemFetchRequest
\brief The QOrganizerItemFetchRequest class allows a client to asynchronously fetch organizer
items from a backend.
\inmodule QtOrganizer
\ingroup organizer-requests
This request will fetch all the items and occurrences matching the specified criteria.
*/
/*!
Constructs a new organizer item fetch request whose parent is the specified \a parent.
*/
QOrganizerItemFetchRequest::QOrganizerItemFetchRequest(QObject *parent)
: QOrganizerAbstractRequest(new QOrganizerItemFetchRequestPrivate, parent)
{
}
/*!
Frees memory in use by this request.
*/
QOrganizerItemFetchRequest::~QOrganizerItemFetchRequest()
{
}
/*!
Sets the organizer item filter used to determine which organizer items will be retrieved to \a filter.
*/
void QOrganizerItemFetchRequest::setFilter(const QOrganizerItemFilter &filter)
{
Q_D(QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
d->m_filter = filter;
}
/*!
Sets the sort order of the result to \a sorting.
*/
void QOrganizerItemFetchRequest::setSorting(const QList<QOrganizerItemSortOrder> &sorting)
{
Q_D(QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
d->m_sorting = sorting;
}
/*!
Sets the fetch hint which may be used by the backend to optimize item retrieval to \a fetchHint.
A client should not make changes to a item which has been retrieved using a fetch hint other than
the default fetch hint. Doing so will result in information loss when saving the item back to
the manager (as the "new" restricted item will replace the previously saved item in the backend).
*/
void QOrganizerItemFetchRequest::setFetchHint(const QOrganizerItemFetchHint &fetchHint)
{
Q_D(QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
d->m_fetchHint = fetchHint;
}
/*!
Sets the start period of the request to \a date.
A default-constructed (invalid) start date time specifies an open start date time (matches anything
which occurs up until the end date time).
*/
void QOrganizerItemFetchRequest::setStartDate(const QDateTime &date)
{
Q_D(QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
d->m_startDate = date;
}
/*!
Sets the end period of the request to \a date.
A default-constructed (invalid) end date time specifies an open end date time (matches anything
which occurs after the start date time).
*/
void QOrganizerItemFetchRequest::setEndDate(const QDateTime &date)
{
Q_D(QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
d->m_endDate = date;
}
/*!
Sets the maximum number of items to be fetched to \a maxCount.
Note that backends will decide how many items are fetched if \a maxCount is negative.
*/
void QOrganizerItemFetchRequest::setMaxCount(int maxCount)
{
Q_D(QOrganizerItemFetchRequest);
d->m_maxCount = maxCount;
}
/*!
Returns the filter that will be used to select organizer items to be returned.
*/
QOrganizerItemFilter QOrganizerItemFetchRequest::filter() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_filter;
}
/*!
Returns the sort ordering that will be used sort the results of this request.
*/
QList<QOrganizerItemSortOrder> QOrganizerItemFetchRequest::sorting() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_sorting;
}
/*!
Returns the fetch hint which may be used by the backend to optimize item retrieval.
A client should not make changes to a item which has been retrieved using a fetch hint other than
the default fetch hint. Doing so will result in information loss when saving the item back to
the manager (as the "new" restricted item will replace the previously saved item in the backend).
*/
QOrganizerItemFetchHint QOrganizerItemFetchRequest::fetchHint() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_fetchHint;
}
/*!
Returns the date-time which is the lower bound for the range in which items will be returned.
*/
QDateTime QOrganizerItemFetchRequest::startDate() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_startDate;
}
/*!
Returns the date-time which is the upper bound for the range in which items will be returned.
*/
QDateTime QOrganizerItemFetchRequest::endDate() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_endDate;
}
/*!
Returns the maximum number of items to return for the request.
*/
int QOrganizerItemFetchRequest::maxCount() const
{
Q_D(const QOrganizerItemFetchRequest);
return d->m_maxCount;
}
/*!
Returns the list of organizer items retrieved by this request.
*/
QList<QOrganizerItem> QOrganizerItemFetchRequest::items() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_organizeritems;
}
QT_END_NAMESPACE_ORGANIZER
#include "moc_qorganizeritemfetchrequest.cpp"
|
