63
|
1 |
/*
|
|
2 |
* Copyright (c) 2005-2007 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: Top Contact opeartion.
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef VPBKTOPCONTACTOPERATION_H
|
|
20 |
#define VPBKTOPCONTACTOPERATION_H
|
|
21 |
|
|
22 |
// INCLUDES
|
|
23 |
#include <e32base.h>
|
|
24 |
#include <MVPbkContactOperationBase.h>
|
|
25 |
#include <MVPbkContactViewObserver.h>
|
|
26 |
#include <MVPbkContactStoreObserver.h>
|
|
27 |
#include <MVPbkBatchOperationObserver.h>
|
|
28 |
#include <MVPbkContactSelector.h>
|
|
29 |
#include <MVPbkOperationObserver.h>
|
|
30 |
#include <MVPbkBatchOperationObserver.h>
|
|
31 |
#include <MVPbkStoreContact.h>
|
|
32 |
|
|
33 |
|
|
34 |
// FORWARD DECLARATIONS
|
|
35 |
class MVPbkContactLink;
|
|
36 |
class MVPbkContactLinkArray;
|
|
37 |
class CVPbkContactLinkArray;
|
|
38 |
class CVPbkContactManager;
|
|
39 |
class MVPbkContactViewBase;
|
|
40 |
class CVPbkSortOrder;
|
|
41 |
class MVPbkContactStore;
|
|
42 |
class CVPbkContactEasyManager;
|
|
43 |
class MVPbkBaseContact;
|
|
44 |
class MVPbkContactFieldTextData;
|
|
45 |
class TVPbkContactStoreUriPtr;
|
|
46 |
class CVPbkSortOrderAcquirer;
|
|
47 |
|
|
48 |
// CLASS DECLARATION
|
|
49 |
|
|
50 |
/**
|
|
51 |
* Top contact manager operation. One class used for all operations, a new instance
|
|
52 |
* is created for each client request.
|
|
53 |
*/
|
|
54 |
NONSHARABLE_CLASS( CVPbkTopContactOperation ) : public CActive,
|
|
55 |
public MVPbkContactOperationBase,
|
|
56 |
public MVPbkContactViewObserver,
|
|
57 |
public MVPbkContactStoreObserver,
|
|
58 |
public MVPbkBatchOperationObserver,
|
|
59 |
public MVPbkOperationObserver,
|
|
60 |
public MVPbkOperationErrorObserver,
|
|
61 |
public MVPbkContactSelector
|
|
62 |
{
|
|
63 |
public:
|
|
64 |
/**
|
|
65 |
* Top contacts operation
|
|
66 |
*/
|
|
67 |
enum TTopOperation
|
|
68 |
{
|
|
69 |
EGetTopContacts,
|
|
70 |
EGetTopContactLinks,
|
|
71 |
EGetNonTopContacts,
|
|
72 |
EGetNonTopContactLinks,
|
|
73 |
EAddToTop,
|
|
74 |
ERemoveFromTop,
|
|
75 |
EReorderTop
|
|
76 |
};
|
|
77 |
|
|
78 |
public:
|
|
79 |
/**
|
|
80 |
* Creates a top contact manager operation that returns a view. Used to
|
|
81 |
* create top and non-top contact views.
|
|
82 |
*
|
|
83 |
* @param aContactManager Contact manager which already has its stores opened.
|
|
84 |
* @param aObserver Receives view when it's ready
|
|
85 |
* @param aErrorObserver Error observer is notified in case of an error
|
|
86 |
* @param aOperation Valid values EGetTopContacts and EGetNonTopContacts
|
|
87 |
*
|
|
88 |
* @return Contact operation handle
|
|
89 |
*/
|
|
90 |
static MVPbkContactOperationBase* NewGetViewOperationL(
|
|
91 |
CVPbkContactManager& aContactManager,
|
|
92 |
MVPbkOperationResultObserver<MVPbkContactViewBase*>& aObserver,
|
|
93 |
MVPbkOperationErrorObserver& aErrorObserver,
|
|
94 |
TTopOperation aOperation );
|
|
95 |
|
|
96 |
/**
|
|
97 |
* Creates a top contact manager operation that returns a contact link array. Used to
|
|
98 |
* receive top and non-top contact links.
|
|
99 |
*
|
|
100 |
* @param aContactManager Contact manager which already has its stores opened.
|
|
101 |
* @param aObserver Receives contact link array when it's ready
|
|
102 |
* @param aErrorObserver Error observer is notified in case of an error
|
|
103 |
* @param aOperation Valid values EGetTopContactLinks and EGetNonTopContactLinks
|
|
104 |
*
|
|
105 |
* @return Contact operation handle
|
|
106 |
*/
|
|
107 |
static MVPbkContactOperationBase* NewGetViewLinksOperationL(
|
|
108 |
CVPbkContactManager& aContactManager,
|
|
109 |
MVPbkOperationResultObserver<MVPbkContactLinkArray*>& aObserver,
|
|
110 |
MVPbkOperationErrorObserver& aErrorObserver,
|
|
111 |
TTopOperation aOperation );
|
|
112 |
|
|
113 |
/**
|
|
114 |
* Creates a top contact manager operation that manipulates top contacts:
|
|
115 |
* add to top contacts, remove from top contacts, reorder top contacts.
|
|
116 |
*
|
|
117 |
* @param aContactManager Contact manager which already has its stores opened.
|
|
118 |
* @param aObserver Receives notification when operation is complete
|
|
119 |
* @param aErrorObserver Error observer is notified in case of an error
|
|
120 |
* @param aOperation valid values EAddToTop,
|
|
121 |
* ERemoveFromTop,
|
|
122 |
* EReorderTop
|
|
123 |
* @param aTopView Top contact view which already has been constructed.
|
|
124 |
* If a NULL value is passed, own top contact view is
|
|
125 |
* constructed.
|
|
126 |
*
|
|
127 |
* @return Contact operation handle
|
|
128 |
*/
|
|
129 |
static MVPbkContactOperationBase* NewTopOperationL(
|
|
130 |
CVPbkContactManager& aContactManager,
|
|
131 |
const MVPbkContactLinkArray& aContactLinks,
|
|
132 |
MVPbkOperationObserver& aObserver,
|
|
133 |
MVPbkOperationErrorObserver& aErrorObserver,
|
|
134 |
TTopOperation aOperation,
|
|
135 |
MVPbkContactViewBase* aViewRef = NULL
|
|
136 |
);
|
|
137 |
|
|
138 |
|
|
139 |
/**
|
|
140 |
* Destructor. Cancels any ongoing requests.
|
|
141 |
*/
|
|
142 |
~CVPbkTopContactOperation();
|
|
143 |
|
|
144 |
/**
|
|
145 |
* Return contact's top index or KErrNotFound
|
|
146 |
*
|
|
147 |
* @param aContact contact item
|
|
148 |
*
|
|
149 |
* @return top index or KErrNotFound
|
|
150 |
*/
|
|
151 |
static TInt TopOrder( const MVPbkBaseContact& aContact );
|
|
152 |
|
|
153 |
private: //From CActive
|
|
154 |
void DoCancel();
|
|
155 |
void RunL();
|
|
156 |
TInt RunError( TInt aError );
|
|
157 |
|
|
158 |
private: // from MVPbkContactViewObserver
|
|
159 |
void ContactViewReady(
|
|
160 |
MVPbkContactViewBase& aView );
|
|
161 |
void ContactViewUnavailable(
|
|
162 |
MVPbkContactViewBase& aView );
|
|
163 |
void ContactAddedToView(
|
|
164 |
MVPbkContactViewBase& aView,
|
|
165 |
TInt aIndex,
|
|
166 |
const MVPbkContactLink& aContactLink );
|
|
167 |
void ContactRemovedFromView(
|
|
168 |
MVPbkContactViewBase& aView,
|
|
169 |
TInt aIndex,
|
|
170 |
const MVPbkContactLink& aContactLink );
|
|
171 |
void ContactViewError(
|
|
172 |
MVPbkContactViewBase& aView,
|
|
173 |
TInt aError,
|
|
174 |
TBool aErrorNotified );
|
|
175 |
|
|
176 |
private: // from MVPbkContactStoreObserver
|
|
177 |
void StoreReady(MVPbkContactStore& aContactStore);
|
|
178 |
void StoreUnavailable(MVPbkContactStore& aContactStore,
|
|
179 |
TInt aReason);
|
|
180 |
void HandleStoreEventL(
|
|
181 |
MVPbkContactStore& aContactStore,
|
|
182 |
TVPbkContactStoreEvent aStoreEvent);
|
|
183 |
|
|
184 |
private: // from MVPbkBatchOperationObserver
|
|
185 |
void StepComplete(
|
|
186 |
MVPbkContactOperationBase& aOperation,
|
|
187 |
TInt aStepSize );
|
|
188 |
TBool StepFailed(
|
|
189 |
MVPbkContactOperationBase& aOperation,
|
|
190 |
TInt aStepSize, TInt aError );
|
|
191 |
void OperationComplete(
|
|
192 |
MVPbkContactOperationBase& aOperation );
|
|
193 |
|
|
194 |
private: // from MVPbkOperationObserver
|
|
195 |
void VPbkOperationCompleted( MVPbkContactOperationBase* aOperation );
|
|
196 |
void VPbkOperationFailed( MVPbkContactOperationBase* aOperation,
|
|
197 |
TInt aError );
|
|
198 |
|
|
199 |
private: // From MVPbkContactSelector
|
|
200 |
TBool IsContactIncluded( const MVPbkBaseContact& aContact );
|
|
201 |
|
|
202 |
private: // construction
|
|
203 |
static CVPbkTopContactOperation* NewLC(
|
|
204 |
CVPbkContactManager& aContactManager,
|
|
205 |
MVPbkOperationErrorObserver& aErrorObserver,
|
|
206 |
TTopOperation aOperation);
|
|
207 |
void ConstructL();
|
|
208 |
CVPbkTopContactOperation(
|
|
209 |
CVPbkContactManager& aContactManager,
|
|
210 |
MVPbkOperationErrorObserver& aErrorObserver,
|
|
211 |
TTopOperation aOperation);
|
|
212 |
|
|
213 |
private: // new methods
|
|
214 |
static void SetTopOrderL(
|
|
215 |
MVPbkContactFieldTextData& aTextData, TInt aTopOrderIndex );
|
|
216 |
void SetTopOrderL(
|
|
217 |
MVPbkStoreContact& aContact, TInt aTopOrderIndex );
|
|
218 |
static const MVPbkContactFieldTextData* FindTopFieldTextData(
|
|
219 |
const MVPbkBaseContact& aContact );
|
|
220 |
static MVPbkContactFieldTextData* FindTopFieldTextData(
|
|
221 |
MVPbkStoreContact& aContact );
|
|
222 |
void OpenStoreL( const TVPbkContactStoreUriPtr& aUri );
|
|
223 |
void OpenDefaultStoreL();
|
|
224 |
|
|
225 |
void RequestTopContactsViewL();
|
|
226 |
void RequestNonTopContactsViewL();
|
|
227 |
|
|
228 |
void Top_RunL();
|
|
229 |
void GetView_RunL();
|
|
230 |
void DoTopOperationL();
|
|
231 |
|
|
232 |
TBool SaveOneContactL();
|
|
233 |
|
|
234 |
static TInt NextTopOrderIndexL(
|
|
235 |
const MVPbkContactViewBase& aView );
|
|
236 |
|
|
237 |
void CompleteOurself();
|
|
238 |
|
|
239 |
static CVPbkContactLinkArray* CloneArrayL(
|
|
240 |
const MVPbkContactLinkArray& aArray );
|
|
241 |
|
|
242 |
static MVPbkContactLinkArray* ViewToLinkArrayL(
|
|
243 |
const MVPbkContactViewBase& aView );
|
|
244 |
|
|
245 |
void SetTopOrderToContactsL(
|
|
246 |
RPointerArray<MVPbkStoreContact>& aContacts,
|
|
247 |
TInt aHighestOrderIndex );
|
|
248 |
|
|
249 |
void RemoveTopnessFromContacts(
|
|
250 |
RPointerArray<MVPbkStoreContact>& aContacts );
|
|
251 |
|
|
252 |
void RemoveTopnessFromContact( MVPbkStoreContact& aContact );
|
|
253 |
|
|
254 |
void ReorderContactsL(
|
|
255 |
RPointerArray<MVPbkStoreContact>& aContacts );
|
|
256 |
|
|
257 |
const MVPbkFieldType& TopContactFieldTypeL();
|
|
258 |
|
|
259 |
void NotifyResultL();
|
|
260 |
void NotifyError(TInt aErr);
|
|
261 |
void AbortWithError(TInt aErr);
|
|
262 |
|
|
263 |
CVPbkSortOrderAcquirer* AllContactsSortOrderL() const;
|
|
264 |
|
|
265 |
private:
|
|
266 |
enum TTopManagementState
|
|
267 |
{
|
|
268 |
EStateNone,
|
|
269 |
EStateOpenStore,
|
|
270 |
EStateCreateView,
|
|
271 |
EStateRetrieveLock,
|
|
272 |
EStateModifyCommit,
|
|
273 |
EStateAbortWithError
|
|
274 |
};
|
|
275 |
|
|
276 |
private: // data
|
|
277 |
const TTopOperation iCurrentOperation;
|
|
278 |
TTopManagementState iNextState;
|
|
279 |
|
|
280 |
CVPbkContactManager& iContactManager; // not owned
|
|
281 |
MVPbkContactViewBase* iView; // owned
|
|
282 |
// A handle to externally provided top contact view
|
|
283 |
MVPbkContactViewBase* iViewRef; // Not owned.
|
|
284 |
|
|
285 |
MVPbkContactStore* iContactStore; // not owned
|
|
286 |
CVPbkContactLinkArray* iInputLinks; // owned
|
|
287 |
RPointerArray<MVPbkStoreContact> iContacts; // owns the contacts
|
|
288 |
MVPbkContactOperationBase* iContactOperation; // own
|
|
289 |
CVPbkContactEasyManager* iContactEasyManager; //own
|
|
290 |
|
|
291 |
// observers, not owned
|
|
292 |
MVPbkOperationObserver* iObserver;
|
|
293 |
MVPbkOperationResultObserver<MVPbkContactViewBase*>* iViewObserver;
|
|
294 |
MVPbkOperationResultObserver<MVPbkContactLinkArray*>* iLinksObserver;
|
|
295 |
MVPbkOperationErrorObserver* iErrorObserver;
|
|
296 |
TInt iAbortError;
|
|
297 |
};
|
|
298 |
|
|
299 |
#endif //VPBKTOPCONTACTOPERATION_H
|
|
300 |
//End of file
|