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
|
/*
* This file is part of buteo-sync-plugins package
*
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
*
* Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
#ifndef NOTESBACKEND_H
#define NOTESBACKEND_H
#include <KCalendarCore/Incidence>
#include <extendedcalendar.h>
#include <extendedstorage.h>
class QDateTime;
namespace Buteo {
class StorageItem;
}
/*! \brief Notes Calendar backend proxy
*
*/
class NotesBackend
{
public:
/*! \brief Constructor
*
*/
NotesBackend();
/*! \brief Destructor
*
*/
virtual ~NotesBackend();
/*! \brief Initializes backend
*
* @return True on success, otherwise false
*/
bool init( const QString& aNotebookName, const QString& aUid, const QString &aMimeType );
/*! \brief Uninitializes backend
*
* @return True on success, otherwise false
*/
bool uninit();
/*! \brief retrieves all Notes from the backend
*
* @param aItems Output Parameter - List of Buteo::StorageItems retrieved from Backend.
* @return True on success, otherwise false
*/
bool getAllNotes( QList<Buteo::StorageItem*>& aItems );
/*! \brief gets are note ids from the backend
*
* @param aIds - list of notes ids
* @return True on success, otherwise false
*/
bool getAllNoteIds( QList<QString>& aIds );
/*! \brief get all new notes from a timestamp
*
* @param aNewItems List of new items.(output parameter)
* @param aTime - time from which to retrieve the notes
* @return True on success, otherwise false
*/
bool getNewNotes( QList<Buteo::StorageItem*>& aNewItems, const QDateTime& aTime );
/*! \brief get all new note ids from a timestamp
*
* @param aNewIds List of new ids (output parameter)
* @param aTime - time from which to retrieve the notes
* @return True on success, otherwise false
*/
bool getNewNoteIds( QList<QString>& aNewIds, const QDateTime& aTime );
/*! \brief get all modified notes from the backend
*
* @param aModifiedItems - list of modified items (output parameter)
* @param aTime - timestamp from which the modified notes are needed.
* @return True on success, otherwise false
*/
bool getModifiedNotes( QList<Buteo::StorageItem*>& aModifiedItems, const QDateTime& aTime );
/*! \brief get all modified notes ids from the backend
*
* @param aModifiedIds - list of modified ids (output parameter)
* @param aTime - timestamp from which the modified notes ids are needed.
* @return True on success, otherwise false
*/
bool getModifiedNoteIds( QList<QString>& aModifiedIds, const QDateTime& aTime );
/*! \brief gets all deleted note ids
*
* @param aDeletedIds - deleted ids.
* @param aTime - timestamp from which the deleted ids are needed.
* @return True on success, otherwise false
*/
bool getDeletedNoteIds( QList<QString>& aDeletedIds, const QDateTime& aTime );
/*! \brief fetch a new StorageItem
*
* @return pointer to the newly created StorageItem
*/
Buteo::StorageItem* newItem();
/*! \brief get an item
*
* @param aItemId - id of the item to get
* @return pointer to the StorageItem
*/
Buteo::StorageItem* getItem( const QString& aItemId );
/*! \brief Uninitializes backend
*
* @param aItem - item to add
* @param aCommitNow - if true persist db changes, if false do this later
* @return True on success, otherwise false
*/
bool addNote( Buteo::StorageItem& aItem, bool commitNow );
/*! \brief Uninitializes backend
*
* @param aItem - item to modify
* @param aCommitNow - if true persist db changes, if false do this later
* @return True on success, otherwise false
*/
bool modifyNote( Buteo::StorageItem& aItem, bool commitNow );
/*! \brief Uninitializes backend
*
* @param aId - id of item to delete
* @param aCommitNow - if true persist db changes, if false do this later
* @return True on success, otherwise false
*/
bool deleteNote( const QString& aId, bool commitNow );
/*! \brief Persist notes db
*
* @return True on success, otherwise false
*/
bool commitChanges();
protected:
private:
void retrieveNoteItems( KCalendarCore::Incidence::List& aIncidences, QList<Buteo::StorageItem*>& aItems );
void retrieveNoteIds( KCalendarCore::Incidence::List& aIncidences, QList<QString>& aIds );
void filterIncidences( KCalendarCore::Incidence::List& aIncidences );
QString iNotebookName;
QString iMimeType;
mKCal::ExtendedCalendar::Ptr iCalendar;
mKCal::ExtendedStorage::Ptr iStorage;
};
#endif // NOTESBACKEND_H
|
