34
|
1 |
/*
|
|
2 |
* Copyright (c) 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 the License "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: Albums related collection functionality.
|
|
15 |
*/
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef VCXMYVIDEOSALBUMS_H
|
|
20 |
#define VCXMYVIDEOSALBUMS_H
|
|
21 |
|
|
22 |
// INCLUDES
|
|
23 |
#include <mdequery.h>
|
|
24 |
#include "vcxmyvideosmdsdb.h"
|
|
25 |
#include "vcxmyvideosalbum.h"
|
|
26 |
|
|
27 |
// FORWARD DECLARATIONS
|
|
28 |
class CVcxMyVideosMdsDb;
|
|
29 |
class CMPXMedia;
|
|
30 |
class CVcxMyVideosCollectionPlugin;
|
|
31 |
class CVcxMyVideosAlbum;
|
|
32 |
|
|
33 |
// CONSTANTS
|
|
34 |
|
|
35 |
// CLASS DECLARATION
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Albums related collection functionality.
|
|
39 |
*
|
|
40 |
* @lib mpxmyvideoscollectionplugin.lib
|
|
41 |
*/
|
|
42 |
NONSHARABLE_CLASS(CVcxMyVideosAlbums) : public CBase, public MVcxMyVideosMdsAlbumsObserver
|
|
43 |
{
|
|
44 |
public: // Constructors and destructor
|
|
45 |
|
|
46 |
/**
|
|
47 |
* Two-phased constructor
|
|
48 |
* @return object constructed
|
|
49 |
*/
|
|
50 |
static CVcxMyVideosAlbums* NewL( CVcxMyVideosCollectionPlugin& aCollectionPlugin );
|
|
51 |
|
|
52 |
/**
|
|
53 |
* Destructor
|
|
54 |
*/
|
|
55 |
virtual ~CVcxMyVideosAlbums();
|
|
56 |
|
|
57 |
public: // new methods
|
|
58 |
|
|
59 |
/**
|
|
60 |
* Returns album from iAlbums array by MDS ID. Ownership does not move.
|
|
61 |
*
|
|
62 |
* @param aMdsId MDS ID of the album to get.
|
|
63 |
* @param aPos If given, then the position index in iAlbums is written here.
|
|
64 |
* Ownership does not move.
|
|
65 |
* @return Pointer to album or NULL if not found.
|
|
66 |
*/
|
|
67 |
CVcxMyVideosAlbum* Album( TUint32 aMdsId, TInt* aPos = NULL );
|
|
68 |
|
|
69 |
/**
|
|
70 |
* Creates iAlbumList if it doesn't exist yet. The list is populated
|
|
71 |
* from async callback, HandleGetAlbumsResp().
|
|
72 |
*/
|
|
73 |
void CreateAlbumListL();
|
|
74 |
|
|
75 |
/**
|
|
76 |
* Fetches MDS IDs from MDS for all videos belonging to albums.
|
|
77 |
* Ie fills iAlbums[*]->iVideoList[*].iMdsId (and iAlbums[*]->iVideoList[*].iRelationMdsId) fields.
|
|
78 |
* Causes several async calls to MDS.
|
|
79 |
*/
|
|
80 |
void GetAlbumContentIdsL();
|
|
81 |
|
|
82 |
/**
|
|
83 |
* Adds videos to album.
|
|
84 |
*
|
|
85 |
* @param aCmd See attribute usage from vcxmyvideosdefs.h.
|
|
86 |
*/
|
|
87 |
void AddVideosToAlbumL( CMPXMedia* aCmd );
|
|
88 |
|
|
89 |
/**
|
|
90 |
* Removes videos from album.
|
|
91 |
*
|
|
92 |
* @param aCmd See attribute usage from vcxmyvideosdefs.h.
|
|
93 |
*/
|
|
94 |
void RemoveVideosFromAlbumL( CMPXMedia* aCmd );
|
|
95 |
|
|
96 |
/**
|
|
97 |
* Adds album to MDS and to this class. KMPXMediaGeneralTitle
|
|
98 |
* should be set in aCmd. Upon completion, the KMPXMediaGeneralId
|
|
99 |
* attribute contains the new MPX item ID. Leaves if could
|
|
100 |
* not add to MDS.
|
|
101 |
*
|
|
102 |
* @param aCmd Command object received from collection client.
|
|
103 |
*/
|
|
104 |
void AddAlbumL( CMPXMedia& aCmd );
|
|
105 |
|
|
106 |
/**
|
|
107 |
* Removes albums from MDS. MDS delete events will clean up albums
|
|
108 |
* from this class.
|
|
109 |
*
|
|
110 |
* @param aCmd MPX command received from the client. Contains media array,
|
|
111 |
* which contains medias with album IDs set to KMPXMediaGeneralId.
|
|
112 |
* Ownership does not move.
|
|
113 |
*/
|
|
114 |
void RemoveAlbumsFromMdsOnlyL( CMPXMedia* aCmd );
|
|
115 |
|
|
116 |
/**
|
|
117 |
* Removes albums from this object (iAlbumList and iAlbums).
|
|
118 |
* Called from MDS delete event. Album IDs which were removed are
|
|
119 |
* also removed from aAlbumIds array. After the call aAlbumIds
|
|
120 |
* will contain items which were not found and not deleted.
|
|
121 |
* Sends appropriate events to collection client.
|
|
122 |
*
|
|
123 |
* @param aAlbumIds Album IDs to be removed.
|
|
124 |
*/
|
|
125 |
void RemoveAlbumsL( RArray<TUint32>& aAlbumIds );
|
|
126 |
|
|
127 |
/**
|
|
128 |
* Removes album from this class (iAlbumList and iAlbums).
|
|
129 |
* Adds event to message list but does not send it.
|
|
130 |
*
|
|
131 |
* @param aMdsIds Album MDS ID to be removed.
|
|
132 |
* @param aCompress If ETrue, then iAlbums is compressed,
|
|
133 |
* otherwise not.
|
|
134 |
* @return ETrue if album was found and removed.
|
|
135 |
*/
|
35
|
136 |
TBool RemoveAlbumL( TUint32 aMdsId, TBool aCompress );
|
34
|
137 |
|
|
138 |
/**
|
|
139 |
* Fetches albums from MDS. This is called from MDS insert event.
|
|
140 |
*
|
|
141 |
* @param aAlbumIds Album IDs to fetch.
|
|
142 |
*/
|
|
143 |
void AddAlbumsFromMdsL( RArray<TUint32>& aAlbumIds );
|
|
144 |
|
|
145 |
/**
|
35
|
146 |
* Updates albums from MDS. This is called from MDS modify event.
|
|
147 |
*
|
|
148 |
* @param aAlbumIds Album IDs to update.
|
|
149 |
*/
|
|
150 |
void UpdateAlbumsFromMdsL( RArray<TUint32>& aAlbumIds );
|
|
151 |
|
|
152 |
/**
|
|
153 |
* Updates album attributes, does not write to MDS. Adds
|
|
154 |
* modify event to iCollection.iMessageList if necessarry.
|
|
155 |
*
|
|
156 |
* @param aAlbum New values are read from this.
|
|
157 |
* @return ETrue if album was modified, EFalse otherwise.
|
|
158 |
*/
|
|
159 |
TBool UpdateAlbumL( const CMPXMedia& aAlbum );
|
|
160 |
|
36
|
161 |
/**
|
|
162 |
* Calculates and updates album media attributes.
|
|
163 |
*/
|
|
164 |
void CalculateAttributesL();
|
|
165 |
|
|
166 |
/**
|
|
167 |
* Called when video's New Video flag changes. Calculates
|
|
168 |
* album attributes for the affected albums. Adds events
|
|
169 |
* to iCollection.iMessageList but does not send them.
|
|
170 |
*
|
|
171 |
* @param aMdsId MDS ID of the changed video.
|
|
172 |
*/
|
|
173 |
void NewVideoFlagChangedL( TUint32 aMdsId );
|
|
174 |
|
|
175 |
/**
|
|
176 |
* Called when video's title changes. Calculates
|
|
177 |
* album attributes for the affected albums. Adds events
|
|
178 |
* to iCollection.iMessageList but does not send them.
|
|
179 |
*
|
|
180 |
* @param aMdsId MDS ID of the changed video.
|
|
181 |
*/
|
|
182 |
void VideoTitleChangedL( TUint32 aMdsId );
|
|
183 |
|
35
|
184 |
protected:
|
|
185 |
|
|
186 |
/**
|
34
|
187 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
188 |
* Process albums arriving from MDS. Response to VcxMyVideosMdsAlbums::GetAlbumsL.
|
|
189 |
*/
|
|
190 |
void HandleGetAlbumsRespL( CMPXMedia* aAlbumList );
|
|
191 |
|
|
192 |
/**
|
|
193 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
194 |
* Process content ids arriving from MDS. Response to VcxMyVideosMdsAlbums::GetAlbumContentIdsL.
|
|
195 |
*
|
|
196 |
* @param aAlbumId ID of the album.
|
|
197 |
* @param aAlbumContent Array containing MDS object IDs. This array is the same which
|
|
198 |
* was given in GetAlbumContentIdsL call.
|
|
199 |
*/
|
|
200 |
void HandleGetAlbumContentIdsRespL( TUint32 aAlbumId,
|
|
201 |
RArray<TVcxMyVideosAlbumVideo>& aAlbumContentIds );
|
|
202 |
|
|
203 |
/**
|
|
204 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
205 |
* Response to VcxMyVideosMdsAlbums::GetAlbumsL.
|
|
206 |
* Sends insert events to collection clients.
|
|
207 |
*
|
|
208 |
* @param aAlbumList Pointer to same array which was given in GetAlbums call.
|
|
209 |
*/
|
|
210 |
void HandleGetAlbumsResp( CMPXMedia* aAlbumList );
|
|
211 |
|
|
212 |
/**
|
|
213 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
214 |
* Process content ids arriving from MDS. Response to CVcxMyVideosMdsAlbums::GetAlbumContentIdsL.
|
|
215 |
*
|
|
216 |
* @param aAlbumId ID of the album.
|
|
217 |
* @param aAlbumContent Array containing MDS object IDs. This array is the same which
|
|
218 |
* was given in GetAlbumContentL call.
|
|
219 |
*/
|
|
220 |
void HandleGetAlbumContentIdsResp( TUint32 aAlbumId,
|
|
221 |
RArray<TVcxMyVideosAlbumVideo>& aAlbumContentIds );
|
|
222 |
|
|
223 |
/**
|
|
224 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
225 |
* Process content videos arriving from MDS. Response to CVcxMyVideosMdsAlbums::GetAlbumContentVideosL.
|
|
226 |
*
|
|
227 |
* @param aAlbumId Album ID.
|
|
228 |
* @param aVideoList Media containing media array, array items are videos.
|
|
229 |
* @param aError Error code in case of failure.
|
|
230 |
* @param aFirstNewItemIndex The index of the first new item.
|
|
231 |
* @param aNewItemCount How many new items since the last results.
|
|
232 |
* @param aComplete ETrue is query is complete, EFalse if there is new to come.
|
|
233 |
*/
|
|
234 |
void HandleGetAlbumContentVideosResp( TUint32 /*aAlbumId*/, CMPXMedia& /*aVideoList*/,
|
|
235 |
TInt /*aError*/, TInt /*aFirstNewItemIndex*/, TInt /*aNewItemCount*/, TBool /*aComplete*/ ) {}
|
|
236 |
|
|
237 |
/**
|
|
238 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
239 |
* Response to CVcxMyVideosMdsAlbums::AddVideosToAlbumL.
|
|
240 |
*
|
|
241 |
* @param aCmd Pointer to object which was given in AddVideosToAlbumL
|
|
242 |
* function call. Ownership does not move.
|
|
243 |
* @param aItemArray Item array which was tried to add to MDS.
|
|
244 |
*/
|
|
245 |
void HandleAddVideosToAlbumResp( CMPXMedia* aCmd,
|
|
246 |
RPointerArray<CMdEInstanceItem>& aItemArray );
|
|
247 |
|
|
248 |
/**
|
|
249 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
250 |
* Response to CVcxMyVideosMdsAlbums::RemoveRelationsL.
|
|
251 |
*/
|
|
252 |
void HandleRemoveRelationsResp( RArray<TUint32>& aRelationIds,
|
|
253 |
RArray<TUint32>& aResults );
|
|
254 |
|
|
255 |
/**
|
|
256 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
257 |
* Response to CVcxMyVideosMdsAlbums::RemoveAlbumsL.
|
|
258 |
*/
|
|
259 |
void HandleRemoveAlbumsResp( CMPXMedia* aCmd,
|
|
260 |
RArray<TUint32>& aResultIds );
|
|
261 |
|
|
262 |
/**
|
|
263 |
* From MVcxMyVideosMdsAlbumsObserver.
|
|
264 |
* Relation events from MDS. This object is set as an observer at
|
|
265 |
* iCollection.ConstructL, CVcxMyVideosMdsDb::NewL(..,aAlbumsObserver,..).
|
|
266 |
*/
|
|
267 |
void HandleRelationEvent( TObserverNotificationType aType,
|
35
|
268 |
const RArray<TMdERelation>& aRelationArray );
|
|
269 |
|
34
|
270 |
private:
|
|
271 |
|
|
272 |
/**
|
|
273 |
* Fills in iAlbums array. This is called when iAlbumList is ready.
|
|
274 |
* Pointers to CVcxMyVideosVideoCache::iVideoList are not filled
|
|
275 |
* in yet.
|
|
276 |
*/
|
|
277 |
void CreateAlbumsL();
|
|
278 |
|
|
279 |
/**
|
|
280 |
* Constructor
|
|
281 |
*/
|
|
282 |
CVcxMyVideosAlbums( CVcxMyVideosCollectionPlugin& aCollectionPlugin );
|
|
283 |
|
|
284 |
/**
|
|
285 |
* Symbian 2nd phase constructor.
|
|
286 |
*/
|
|
287 |
void ConstructL();
|
|
288 |
|
|
289 |
/**
|
|
290 |
* Leaving version of HandleAddVideosToAlbumResp.
|
|
291 |
*/
|
|
292 |
void DoHandleAddVideosToAlbumRespL( CMPXMedia* aCmd,
|
|
293 |
RPointerArray<CMdEInstanceItem>& aItemArray );
|
|
294 |
|
|
295 |
public:
|
|
296 |
|
|
297 |
/**
|
|
298 |
* Album list. This is given to client when categorylevel items are requested. Own.
|
|
299 |
* If this is destroyed/edited, then pointers have to be updated in iAlbums.
|
|
300 |
*/
|
|
301 |
CMPXMedia* iAlbumList;
|
|
302 |
|
|
303 |
/**
|
|
304 |
* Array containing MDS IDs and pointers to album and video media items.
|
|
305 |
* Album media items are in iAlbumList and video media items are in
|
|
306 |
* CVcxMyVideosVideoCache::iVideoList.
|
|
307 |
*/
|
|
308 |
RArray<CVcxMyVideosAlbum*> iAlbums;
|
|
309 |
|
|
310 |
/**
|
|
311 |
* ETrue when iAlbumList is ready and iAlbums contains video IDs.
|
|
312 |
*/
|
|
313 |
TBool iAlbumListIsComplete;
|
|
314 |
|
|
315 |
private:
|
|
316 |
|
|
317 |
/**
|
|
318 |
* Owner of this object.
|
|
319 |
*/
|
|
320 |
CVcxMyVideosCollectionPlugin& iCollection;
|
|
321 |
|
|
322 |
/**
|
|
323 |
* Used in MDS operations to store MDS video (or relation) IDs.
|
|
324 |
*/
|
|
325 |
RArray<TUint32> iMdsOpTargetIds;
|
|
326 |
|
|
327 |
/**
|
35
|
328 |
* Stores album video data during relation deletion. This is to
|
34
|
329 |
* avoid second search when resp arrives.
|
|
330 |
*/
|
|
331 |
RArray<TVcxMyVideosAlbumVideo> iRemoveFromAlbumVideos;
|
|
332 |
|
|
333 |
/**
|
|
334 |
* Used in MDS operations to store operation results. Is in sync with iMdsOpTargetIds.
|
|
335 |
*/
|
|
336 |
RArray<TInt> iMdsOpResults;
|
|
337 |
|
|
338 |
/**
|
|
339 |
* Used in MDS operations to store operation results. Is in sync with iMdsOpTargetIds.
|
|
340 |
*/
|
|
341 |
RArray<TUint32> iMdsOpResultsUint32;
|
|
342 |
|
|
343 |
};
|
|
344 |
|
|
345 |
#endif // VCXMYVIDEOSALBUMS_H
|
|
346 |
|
|
347 |
|