|
85
|
1 |
/*
|
|
|
2 |
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
|
|
|
3 |
* All rights reserved.
|
|
|
4 |
* This component and the accompanying materials are made available
|
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
|
6 |
* which accompanies this distribution, and is available
|
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
|
8 |
*
|
|
|
9 |
* Initial Contributors:
|
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
|
11 |
*
|
|
|
12 |
* Contributors:
|
|
|
13 |
*
|
|
|
14 |
* Description: Interface for CA database implementations
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
#ifndef CASTORAGEPROXY_H
|
|
|
19 |
#define CASTORAGEPROXY_H
|
|
|
20 |
|
|
93
|
21 |
#include "cadef.h"
|
|
85
|
22 |
#include "caoperationparams.h"
|
|
|
23 |
|
|
|
24 |
|
|
|
25 |
// FORWARD DECLARATIONS
|
|
|
26 |
class CCaStorage;
|
|
|
27 |
class CCaInnerQuery;
|
|
|
28 |
class CCaInnerEntry;
|
|
|
29 |
class CCaLocalizationEntry;
|
|
|
30 |
class MCaSessionNorifier;
|
|
|
31 |
|
|
|
32 |
/**
|
|
|
33 |
* Interface for CA database implementations.
|
|
|
34 |
*
|
|
|
35 |
*/
|
|
|
36 |
class CCaStorageProxy: public CBase
|
|
|
37 |
{
|
|
|
38 |
public:
|
|
86
|
39 |
|
|
85
|
40 |
/**
|
|
|
41 |
* Two-phased constructor.
|
|
|
42 |
*/
|
|
|
43 |
static CCaStorageProxy* NewL();
|
|
|
44 |
|
|
|
45 |
/**
|
|
|
46 |
* Two-phased constructor.
|
|
|
47 |
*/
|
|
|
48 |
static CCaStorageProxy* NewLC();
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Destructor.
|
|
|
52 |
*/
|
|
|
53 |
~CCaStorageProxy();
|
|
86
|
54 |
|
|
85
|
55 |
/**
|
|
|
56 |
* Localizes one entry attribute
|
|
|
57 |
*
|
|
|
58 |
* @param aLocalization information about one localization row.
|
|
|
59 |
*/
|
|
|
60 |
IMPORT_C void LocalizeEntryL( CCaLocalizationEntry& aLocalization );
|
|
|
61 |
|
|
|
62 |
/**
|
|
|
63 |
* Fetches localization data from database
|
|
|
64 |
*
|
|
|
65 |
* @param aResultContainer Target for results.
|
|
|
66 |
*/
|
|
86
|
67 |
IMPORT_C void GetLocalizationsL(
|
|
|
68 |
RPointerArray<CCaLocalizationEntry>& aResultContainer );
|
|
85
|
69 |
|
|
|
70 |
/**
|
|
|
71 |
* Fetches data from storage.
|
|
|
72 |
* @param aQuery Query filter for entries to be fetched.
|
|
|
73 |
* @param aResult Result entry container.
|
|
|
74 |
*/
|
|
86
|
75 |
IMPORT_C void GetEntriesL( const CCaInnerQuery* aQuery,
|
|
85
|
76 |
RPointerArray<CCaInnerEntry>& aResultContainer );
|
|
|
77 |
|
|
|
78 |
/**
|
|
|
79 |
* Fetches entry ids from storage.
|
|
|
80 |
* @param aQuery Query filter for entries' ids to be fetched.
|
|
|
81 |
* @param aResultIdArray Result entry id array.
|
|
|
82 |
*/
|
|
|
83 |
IMPORT_C void GetEntriesIdsL( const CCaInnerQuery* aQuery,
|
|
|
84 |
RArray<TInt>& aResultIdArray );
|
|
|
85 |
|
|
|
86 |
/**
|
|
|
87 |
* Adds or Updates data to storage.
|
|
93
|
88 |
* In case when data is added the input aEntry serves.
|
|
85
|
89 |
* also as an output entry.
|
|
|
90 |
* @param aEntry Entry data.
|
|
93
|
91 |
* @param aUpdate is entry updated by a client.
|
|
|
92 |
* @param aItemAppearanceChange a type of change of the item.
|
|
85
|
93 |
*/
|
|
93
|
94 |
IMPORT_C void AddL( CCaInnerEntry* aEntry,
|
|
|
95 |
TBool aUpdate = EFalse,
|
|
|
96 |
TItemAppearance aItemAppearanceChange = EItemAppearanceNotChanged );
|
|
85
|
97 |
|
|
|
98 |
/**
|
|
|
99 |
* Removes entries from storage.
|
|
|
100 |
* @param aEntryIds Ids of entries to be removed.
|
|
|
101 |
*/
|
|
|
102 |
IMPORT_C void RemoveL( const RArray<TInt>& aEntryIds );
|
|
|
103 |
|
|
|
104 |
/**
|
|
|
105 |
* Organizes entries in storage.
|
|
86
|
106 |
* @param aEntryIds Entry ids to be organized
|
|
85
|
107 |
* (insert, remove, append, prepend are possible).
|
|
|
108 |
* @param aParams Organize parameters.
|
|
|
109 |
*/
|
|
|
110 |
IMPORT_C void OrganizeL( const RArray<TInt>& aEntryIds,
|
|
|
111 |
TCaOperationParams aParams );
|
|
|
112 |
|
|
|
113 |
/**
|
|
86
|
114 |
* Executes touch specific actions on storage.
|
|
85
|
115 |
* Should be called when e.g. entry is clicked.
|
|
|
116 |
* @param aEntry entry to be touched
|
|
|
117 |
*/
|
|
|
118 |
IMPORT_C void TouchL( CCaInnerEntry* aEntry );
|
|
86
|
119 |
|
|
85
|
120 |
/**
|
|
|
121 |
* Get database property on storage.
|
|
|
122 |
*
|
|
|
123 |
* @param aProperty The property to get.
|
|
|
124 |
* @param aPropertyValue The value of property.
|
|
|
125 |
*/
|
|
|
126 |
IMPORT_C void DbPropertyL( const TDesC& aProperty, TDes& aPropertyValue );
|
|
86
|
127 |
|
|
85
|
128 |
/**
|
|
|
129 |
* Set property action on storage.
|
|
|
130 |
*
|
|
|
131 |
* @param aProperty The property to set.
|
|
|
132 |
* @param aPropertyValue The value of property.
|
|
|
133 |
*/
|
|
86
|
134 |
IMPORT_C void SetDBPropertyL( const TDesC& aProperty,
|
|
|
135 |
const TDesC& aPropertyValue );
|
|
|
136 |
|
|
85
|
137 |
/**
|
|
|
138 |
* Organizes data within a group in custom order in storage.
|
|
|
139 |
*
|
|
|
140 |
* @param aEntryIds Ids of entries in custom order.
|
|
|
141 |
* @param aGroupId Group to sort.
|
|
|
142 |
*/
|
|
86
|
143 |
IMPORT_C void CustomSortL( const RArray<TInt>& aEntryIds,
|
|
|
144 |
const TInt aGroupId );
|
|
|
145 |
|
|
|
146 |
/**
|
|
|
147 |
* Loads data base from rom.
|
|
|
148 |
*/
|
|
|
149 |
IMPORT_C void LoadDataBaseFromRomL();
|
|
|
150 |
|
|
85
|
151 |
/**
|
|
|
152 |
* Add a session. Ownership not taken, this object only keeps a list of
|
|
|
153 |
* sessions that are dependent on its engine.
|
|
|
154 |
* @param aSession Session.
|
|
|
155 |
*/
|
|
|
156 |
void AddSessionL( MCaSessionNorifier* aHandlerNotifier );
|
|
86
|
157 |
|
|
85
|
158 |
/**
|
|
|
159 |
* Remove a session. Safe to call if not added.
|
|
|
160 |
* When no more sessions remain dependent on this object, timed
|
|
|
161 |
* self-deletion is scheduled.
|
|
|
162 |
*/
|
|
|
163 |
void RemoveSession( MCaSessionNorifier* aHandlerNotifier );
|
|
|
164 |
|
|
|
165 |
private:
|
|
|
166 |
|
|
|
167 |
/**
|
|
|
168 |
* Perform the second phase construction of a CCpStorageEngine object.
|
|
|
169 |
*/
|
|
|
170 |
void ConstructL();
|
|
|
171 |
|
|
|
172 |
/**
|
|
|
173 |
* C++ default constructor.
|
|
|
174 |
*/
|
|
|
175 |
CCaStorageProxy();
|
|
|
176 |
|
|
|
177 |
private:
|
|
|
178 |
//Data
|
|
|
179 |
|
|
|
180 |
/**
|
|
|
181 |
* Data storage. Own.
|
|
|
182 |
*/
|
|
|
183 |
CCaStorage* iStorage;
|
|
|
184 |
|
|
|
185 |
/**
|
|
|
186 |
* Sessions using this engine. Own.
|
|
|
187 |
*/
|
|
86
|
188 |
RPointerArray<MCaSessionNorifier> iHandlerNotifier;
|
|
85
|
189 |
};
|
|
|
190 |
|
|
|
191 |
#endif //CASTORAGEPROXY_H
|