|
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: Fill manager interface |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef M_CMFMMANAGER_H |
|
20 #define M_CMFMMANAGER_H |
|
21 |
|
22 // INCLUDE FILES |
|
23 #include <e32std.h> |
|
24 #include <badesca.h> |
|
25 #include "cmcommon.h" |
|
26 #include "cmcommontypes.h" |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class CCmSqlPropertyCollector; |
|
30 class CCmSqlPropertyContainer; |
|
31 class MUPnPAVController; |
|
32 class CCmMediaServerFull; |
|
33 |
|
34 /** |
|
35 * Defines the fill manager interface |
|
36 * |
|
37 * This class defines the fill manager interface. Provides methods to |
|
38 * execute fill specific services |
|
39 * |
|
40 * @lib cmfillmanager.lib |
|
41 * |
|
42 * @since S60 5.1 |
|
43 */ |
|
44 NONSHARABLE_CLASS( MCmFmManager ) |
|
45 { |
|
46 |
|
47 public: |
|
48 |
|
49 /** |
|
50 * Starts fill service |
|
51 * |
|
52 * @since S60 5.1 |
|
53 * @param None |
|
54 * @return None |
|
55 */ |
|
56 virtual void StartFillL() = 0; |
|
57 |
|
58 /** |
|
59 * Cancels fill service |
|
60 * |
|
61 * @since S60 5.1 |
|
62 * @param None |
|
63 * @return None |
|
64 */ |
|
65 virtual void CancelOperation() = 0; |
|
66 |
|
67 /** |
|
68 * Pre-process fill lists |
|
69 * |
|
70 * @since S60 5.1 |
|
71 * @param None |
|
72 * @return None |
|
73 */ |
|
74 virtual void PreProcessListsL() = 0; |
|
75 |
|
76 /** |
|
77 * Processes defined fill list |
|
78 * |
|
79 * @since S60 5.1 |
|
80 * @param aFillListName, name of the fill list |
|
81 * @return None |
|
82 */ |
|
83 virtual void PreProcessListL( const TDesC8& aFillListName ) = 0; |
|
84 |
|
85 /** |
|
86 * Provides metadata column item list |
|
87 * |
|
88 * @since S60 5.1 |
|
89 * @param aType, metadata field |
|
90 * @param aMedia, media type |
|
91 * @param aArray, array of field values |
|
92 * @return None |
|
93 */ |
|
94 virtual void GetColItemsL( TCmMetadataField aType, |
|
95 TCmMediaType aMedia, CDesCArray& aArray ) = 0; |
|
96 |
|
97 /** |
|
98 * Provides metadata column item list |
|
99 * |
|
100 * @since S60 5.1 |
|
101 * @param aType, metadata field |
|
102 * @param aMedia, media type |
|
103 * @param aPropertys, container of field values |
|
104 * @return None |
|
105 */ |
|
106 virtual void GetColItemsL( TCmMetadataField aType, |
|
107 TCmMediaType aMedia, CCmSqlPropertyContainer& aPropertys ) = 0; |
|
108 |
|
109 /** |
|
110 * Provides metadata items list |
|
111 * |
|
112 * @since S60 5.1 |
|
113 * @param aPropertys, property collector reference |
|
114 * @return None |
|
115 */ |
|
116 virtual void GetMetadataItemsL( |
|
117 CCmSqlPropertyCollector& aPropertys ) = 0; |
|
118 /** |
|
119 * Sets av controller |
|
120 * |
|
121 * @since S60 5.1 |
|
122 * @param aAVController, pointer to av controller |
|
123 * @return None |
|
124 */ |
|
125 virtual void SetAvController( MUPnPAVController* aAVController ) = 0; |
|
126 |
|
127 /** |
|
128 * Update fill list item priorities |
|
129 * |
|
130 * @since S60 5.1 |
|
131 * @param None |
|
132 * @return None |
|
133 */ |
|
134 virtual void UpdatePriorities() = 0; |
|
135 |
|
136 /** |
|
137 * Update fill list item reference values |
|
138 * |
|
139 * @since S60 5.1 |
|
140 * @param None |
|
141 * @return None |
|
142 */ |
|
143 virtual void UpdateRefIds() = 0; |
|
144 |
|
145 /** |
|
146 * Delete metadata from defined servers |
|
147 * |
|
148 * @since S60 5.1 |
|
149 * @param None |
|
150 * @return None |
|
151 */ |
|
152 virtual void DeleteMetadataL() = 0; |
|
153 |
|
154 /** |
|
155 * Closes the utility and deletes the object |
|
156 * |
|
157 * @since S60 5.1 |
|
158 * @param None |
|
159 * @return None |
|
160 */ |
|
161 virtual void Close() = 0; |
|
162 |
|
163 }; |
|
164 |
|
165 |
|
166 #endif // M_CMFMMANAGER_H |
|
167 |
|
168 // End of File |