|
1 /* |
|
2 * Copyright (c) 2002 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: |
|
15 * Data structures used fro detailed error data in |
|
16 * WV engine API. |
|
17 * |
|
18 */ |
|
19 |
|
20 |
|
21 #ifndef CImpsDetailed_H |
|
22 #define CImpsDetailed_H |
|
23 |
|
24 // INCLUDES |
|
25 #include <e32base.h> |
|
26 #include <badesca.h> |
|
27 |
|
28 |
|
29 // FORWARD DECLARATIONS |
|
30 class CImpsDetailedResult; |
|
31 |
|
32 // CLASS DECLARATION |
|
33 |
|
34 /** |
|
35 * Data structure for array of DetailedResults |
|
36 */ |
|
37 class CImpsDetailed :public CArrayPtrFlat<CImpsDetailedResult> |
|
38 { |
|
39 public: |
|
40 /* |
|
41 * Constructor |
|
42 */ |
|
43 IMPORT_C CImpsDetailed(TInt aGranularity); |
|
44 |
|
45 /* |
|
46 * Destructor |
|
47 */ |
|
48 IMPORT_C virtual ~CImpsDetailed(); |
|
49 |
|
50 }; |
|
51 |
|
52 |
|
53 /** |
|
54 * Data structure for DetailedResult in CSP primitives |
|
55 */ |
|
56 class CImpsDetailedResult :public CBase |
|
57 { |
|
58 |
|
59 public: // Constructors and destructor |
|
60 |
|
61 /** |
|
62 * Two-phased constructor. |
|
63 */ |
|
64 IMPORT_C static CImpsDetailedResult* NewL(); |
|
65 |
|
66 /** |
|
67 * Destructor. |
|
68 */ |
|
69 IMPORT_C virtual ~CImpsDetailedResult(); |
|
70 |
|
71 public: // New functions |
|
72 |
|
73 /** |
|
74 * Error code accessor |
|
75 * @return Code |
|
76 */ |
|
77 IMPORT_C TInt Code() const; |
|
78 |
|
79 /** |
|
80 * Error code mutator |
|
81 * @param aCode Code |
|
82 */ |
|
83 IMPORT_C void SetCode( TInt aCode ); |
|
84 |
|
85 /** |
|
86 * Descriptor accessor |
|
87 * @return Description |
|
88 */ |
|
89 IMPORT_C TPtrC Descriptor() const; |
|
90 |
|
91 /** |
|
92 * Descriptor mutator |
|
93 * @param aDes textual descriptor of error |
|
94 */ |
|
95 IMPORT_C void SetDescriptorL( TDesC& aDes ); |
|
96 |
|
97 /** |
|
98 * User id accessor |
|
99 * @return UserID* |
|
100 */ |
|
101 IMPORT_C CPtrC16Array* UserIds() const; |
|
102 |
|
103 /** |
|
104 * User id accessor |
|
105 * @return UserID* |
|
106 */ |
|
107 IMPORT_C CPtrC16Array* UserIds(); |
|
108 |
|
109 /** |
|
110 * Group id accessor |
|
111 * @return GroupID* |
|
112 */ |
|
113 IMPORT_C const CPtrC16Array* GroupIds() const; |
|
114 |
|
115 /** |
|
116 * Group id accessor |
|
117 * @return GroupID* |
|
118 */ |
|
119 IMPORT_C CPtrC16Array* GroupIds(); |
|
120 |
|
121 /** |
|
122 * Message id accessor |
|
123 * @return MessageID* |
|
124 */ |
|
125 IMPORT_C const CPtrC16Array* MessageIds() const; |
|
126 |
|
127 /** |
|
128 * Message id accessor |
|
129 * @return MessageID* |
|
130 */ |
|
131 IMPORT_C CPtrC16Array* MessageIds(); |
|
132 |
|
133 /** |
|
134 * ScreenName(SName) accessor |
|
135 * Corresponding GroupID is found by SNameGroups using |
|
136 * the same array index |
|
137 * @return SName |
|
138 */ |
|
139 IMPORT_C const CPtrC16Array* SNames() const; |
|
140 |
|
141 /** |
|
142 * ScreenName(SName) accessor |
|
143 * Corresponding GroupID is found by SNameGroups using |
|
144 * the same array index |
|
145 * @return SName |
|
146 */ |
|
147 IMPORT_C CPtrC16Array* SNames(); |
|
148 |
|
149 /** |
|
150 * ScreenName(GroupID) accessor. |
|
151 * Corresponding SName is found by SNames using |
|
152 * the same array index |
|
153 * @return GroupID* |
|
154 */ |
|
155 IMPORT_C const CPtrC16Array* SNameGroups() const; |
|
156 |
|
157 /** |
|
158 * ScreenName(GroupID) accessor. |
|
159 * Corresponding SName is found by SNames using |
|
160 * the same array index |
|
161 * @return GroupID* |
|
162 */ |
|
163 IMPORT_C CPtrC16Array* SNameGroups(); |
|
164 |
|
165 /** |
|
166 * Reset |
|
167 */ |
|
168 IMPORT_C void Reset(); |
|
169 |
|
170 private: |
|
171 /** |
|
172 * C++ default constructor. |
|
173 */ |
|
174 CImpsDetailedResult(); |
|
175 |
|
176 /** |
|
177 * By default constructor is private. |
|
178 */ |
|
179 void ConstructL(); |
|
180 |
|
181 private: // Data |
|
182 TInt iCode; // code |
|
183 TPtrC iDescription; // description, just a reference |
|
184 CPtrC16Array* iUserIds; // user-Id |
|
185 CPtrC16Array* iGroupIds; // group-id |
|
186 CPtrC16Array* iMessageIds; // Message-id |
|
187 CPtrC16Array* iScreenNames; // Screename::Sname |
|
188 CPtrC16Array* iGroupNames; // ScreenName::GroupId |
|
189 |
|
190 }; |
|
191 |
|
192 #endif |
|
193 |
|
194 // End of File |