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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qorganizeritemfetchrequest.h"
#include "qorganizeritemrequests_p.h"
QTM_BEGIN_NAMESPACE
/*!
\class QOrganizerItemFetchRequest
\brief The QOrganizerItemFetchRequest class allows a client to asynchronously
request organizer items from an organizer item store manager.
\inmodule QtOrganizer
\since 1.1
For a QOrganizerItemFetchRequest, the resultsAvailable() signal will be emitted when the resultant
organizer item (which may be retrieved by calling items()), are updated, as well as if
the overall operation error (which may be retrieved by calling error()) is updated.
\ingroup organizer-requests
*/
/*! Constructs a new organizer item fetch request whose parent is the specified \a parent
\since 1.1
*/
QOrganizerItemFetchRequest::QOrganizerItemFetchRequest(QObject* parent)
: QOrganizerAbstractRequest(new QOrganizerItemFetchRequestPrivate, parent)
{
}
/*! Frees memory in use by this request
\since 1.2
*/
QOrganizerItemFetchRequest::~QOrganizerItemFetchRequest()
{
QOrganizerAbstractRequestPrivate::notifyEngine(this);
}
/*! Sets the organizer item filter used to determine which organizer items will be retrieved to \a filter
\since 1.1
*/
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. Only has an effect if called prior to calling \c start()
\since 1.1
*/
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 organizer item retrieval
to \a fetchHint. A client should not make changes to a organizer 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 organizer item back to the manager (as the "new" restricted organizer item will
replace the previously saved organizer item in the backend).
\sa QOrganizerItemFetchHint
\since 1.1
*/
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. Only has an effect if called prior to calling \c start()
\since 1.1
*/
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. Only has an effect if called prior to calling \c start()
\since 1.1
*/
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 \a maxCount. Only has an effect if called prior to calling \c start()
*
* A negative value denotes that no limit will be imposed on the number of items to fetch.
\since 1.2
*/
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
\since 1.1
*/
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
\since 1.1
*/
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 organizer item retrieval.
A client should not make changes to an organizer 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 organizer item back to the manager (as the "new" restricted organizer item will
replace the previously saved organizer item in the backend).
\sa QOrganizerItemFetchHint
\since 1.1
*/
QOrganizerItemFetchHint QOrganizerItemFetchRequest::fetchHint() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_fetchHint;
}
/*!
Returns the start date of the request. The start date
is the lower bound of the time-period within which an
item must occur (that is, either it or one of its occurrences
must have a time-period defined by its start-date and end-date
which overlaps with the time-period defined in this request)
in order to be returned by the request.
An empty or invalid start date signifies a start date of
negative-infinity (that is, all items which occur at any
point in time, up until the end date, will be returned).
\since 1.1
*/
QDateTime QOrganizerItemFetchRequest::startDate() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_startDate;
}
/*!
Returns the end date of the request. The end date
is the upper bound of the time-period within which an
item must occur (that is, either it or one of its occurrences
must have a time-period defined by its start-date and end-date
which overlaps with the time-period defined in this request)
in order to be returned by the request.
An empty or invalid end date signifies an end date of
positive-infinity (that is, all items which occur at any
point in time after the start date, will be returned).
\since 1.1
*/
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.
A negative value denotes that no limit will be imposed on the number of items to fetch.
The default value is -1.
\since 1.1
*/
int QOrganizerItemFetchRequest::maxCount() const
{
Q_D(const QOrganizerItemFetchRequest);
return d->m_maxCount;
}
/*! Returns the list of organizer items retrieved by this request
\since 1.1
*/
QList<QOrganizerItem> QOrganizerItemFetchRequest::items() const
{
Q_D(const QOrganizerItemFetchRequest);
QMutexLocker ml(&d->m_mutex);
return d->m_organizeritems;
}
#include "moc_qorganizeritemfetchrequest.cpp"
QTM_END_NAMESPACE
|
