64
|
1 |
/*
|
|
2 |
* Copyright (c) 2007-2009 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 definition for ESMR meeting request entry
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef MESMRMEETINGREQUESTENTRY_H
|
|
20 |
#define MESMRMEETINGREQUESTENTRY_H
|
|
21 |
|
|
22 |
//<cmail>
|
|
23 |
#include "mesmrcalentry.h"
|
|
24 |
#include "esmrdef.h"
|
|
25 |
//</cmail>
|
|
26 |
|
|
27 |
class CCalAttendee;
|
|
28 |
class MMRInfoObject;
|
|
29 |
class TESMRInputParams;
|
|
30 |
class CMRMailboxUtils;
|
|
31 |
|
|
32 |
/**
|
|
33 |
* MESMRCalEntry provides utility functions for handling MR Entry.
|
|
34 |
*
|
|
35 |
* @lib esmrservices.lib
|
|
36 |
*/
|
|
37 |
class MESMRMeetingRequestEntry : public MESMRCalEntry
|
|
38 |
{
|
|
39 |
public:
|
|
40 |
/** Enumeration for meeting request entry information */
|
|
41 |
enum TESMREntryInfo
|
|
42 |
{
|
|
43 |
EESMREntryInfoOutOfDate, // Entry is ouyt of date
|
|
44 |
EESMREntryInfoCancelled, // Entry is cancelled
|
|
45 |
EESMREntryInfoAccepted, // Entry is accepted
|
|
46 |
EESMREntryInfoTentativelyAccepted, // Entry is tentatively accepted
|
|
47 |
EESMREntryInfoDeclined, // Entry is declined
|
|
48 |
EESMREntryInfoOccursInPast, // Entry occurs in past
|
|
49 |
EESMREntryInfoConflicts, // Entry conflicts with another entry
|
|
50 |
EESMREntryInfoNormal // Normal case
|
|
51 |
};
|
|
52 |
|
|
53 |
public:
|
|
54 |
/**
|
|
55 |
* Virtual destructor.
|
|
56 |
*/
|
|
57 |
virtual ~MESMRMeetingRequestEntry() { }
|
|
58 |
|
|
59 |
public:
|
|
60 |
|
|
61 |
/**
|
|
62 |
* Tests whether entry is sent or not
|
|
63 |
*/
|
|
64 |
virtual TBool IsSentL() const = 0;
|
|
65 |
|
|
66 |
/**
|
|
67 |
* Fetches the phone owner's role in this calendar entry.
|
|
68 |
* @return User role.
|
|
69 |
* @see TESMRRole.
|
|
70 |
*/
|
|
71 |
virtual TESMRRole RoleL() const = 0;
|
|
72 |
|
|
73 |
/**
|
|
74 |
* Checks, if this entry conflicts with other entries.
|
|
75 |
* @return ETrue, if conflicts exists.
|
|
76 |
*/
|
|
77 |
virtual TBool Conflicts() const = 0;
|
|
78 |
|
|
79 |
/**
|
|
80 |
* For organizer, this marks meeting cancelled.
|
|
81 |
* For attendee, this constructs response entry
|
|
82 |
* and marks attendee status 'declined'.
|
|
83 |
*/
|
|
84 |
virtual void MarkMeetingCancelledL() = 0;
|
|
85 |
|
|
86 |
/**
|
|
87 |
* Constructs reply entry and sets attendee status.
|
|
88 |
* Phone owner needs to be found from entrys attendee list
|
|
89 |
* and role needs to be participant or optional participant.
|
|
90 |
*
|
|
91 |
* @param aStatus Attendee status
|
|
92 |
*/
|
|
93 |
virtual void ConstructReplyL(
|
|
94 |
TESMRAttendeeStatus aStatus ) = 0;
|
|
95 |
|
|
96 |
/**
|
|
97 |
* Tests, whether entry is out of date. Entry is out of date, if
|
|
98 |
* newer entry exists in calendar db.
|
|
99 |
* @return ETrue, if entry is out of date.
|
|
100 |
*/
|
|
101 |
virtual TBool IsEntryOutOfDateL() const = 0;
|
|
102 |
|
|
103 |
/**
|
|
104 |
* Tests, if meeting is cancelled.
|
|
105 |
* @return ETrue, if meeting is cancelled.
|
|
106 |
*/
|
|
107 |
virtual TBool IsMeetingCancelledL() const = 0;
|
|
108 |
|
|
109 |
/**
|
|
110 |
* Fetches attendee status. Phone owner needs to be in the attendee
|
|
111 |
* list.
|
|
112 |
* @return Attendee status.
|
|
113 |
* @error KErrNotFound if phone owner not found from attendee list.
|
|
114 |
*/
|
|
115 |
virtual TESMRAttendeeStatus AttendeeStatusL() const = 0;
|
|
116 |
|
|
117 |
/**
|
|
118 |
* Tests if this is forwarded entry.
|
|
119 |
* @return ETrue, if entry is forwarded.
|
|
120 |
*/
|
|
121 |
virtual TBool IsForwardedL() const = 0;
|
|
122 |
|
|
123 |
/**
|
|
124 |
* Switched entry into forward mode. Current entry's all fields remain
|
|
125 |
* as they are.Entry's method is switched into request and attendee
|
|
126 |
* list is emptied.
|
|
127 |
* @error KErrNotSupported Current entry cannot be forwarded.
|
|
128 |
*/
|
|
129 |
virtual void SwitchToForwardL() = 0;
|
|
130 |
|
|
131 |
/**
|
|
132 |
* Switched entry into orginal mode. Entry is restored to same state
|
|
133 |
* before switching into forwarding mode.
|
|
134 |
* @error KErrNotSupported Current entry cannot be forwarded.
|
|
135 |
*/
|
|
136 |
virtual void SwitchToOrginalL() = 0;
|
|
137 |
|
|
138 |
/**
|
|
139 |
* Sets entry's status to confirmed.
|
|
140 |
*/
|
|
141 |
virtual void ConfirmEntryL() = 0;
|
|
142 |
|
|
143 |
/**
|
|
144 |
* Checks, whether entry occurs in the past
|
|
145 |
* @return ETrue, if entry occurs in the past.
|
|
146 |
*/
|
|
147 |
virtual TBool OccursInPastL() const = 0;
|
|
148 |
|
|
149 |
/**
|
|
150 |
* Fetches entry information in attendee mode.
|
|
151 |
* Method will leave if phone owner is organizer.
|
|
152 |
* @return Entry attendee information
|
|
153 |
* @error KErrNotSupported Phone owner is organizer.
|
|
154 |
*/
|
|
155 |
virtual TESMREntryInfo EntryAttendeeInfoL() const = 0;
|
|
156 |
|
|
157 |
/**
|
|
158 |
* Fetches attendees from entry. Attendees are added to
|
|
159 |
* aAttendeeArray. Attendees are filtered according to aFilterFlags
|
|
160 |
* parameter.
|
|
161 |
* Filtering flags is combimnation of enumeration TESMRRole values.
|
|
162 |
* For example, aFilterFlags = EESMRRoleRequiredAttendee --> Required
|
|
163 |
* attendees are included to array. Ownership of the attendee objects is
|
|
164 |
* not transferred.
|
|
165 |
* @param aAttendeeArray Reference to attendee array
|
|
166 |
* @param aFilterFlags Attendee filtering flags.
|
|
167 |
*/
|
|
168 |
virtual void GetAttendeesL(
|
|
169 |
RArray<CCalAttendee*>& aAttendeeArray,
|
|
170 |
TUint aFilterFlags ) const = 0;
|
|
171 |
|
|
172 |
/**
|
|
173 |
* Fetches the conflicting entries. Conflicting entries are added
|
|
174 |
* to aEntryArray.
|
|
175 |
* @param aEntryArray Array containing conflicting entries
|
|
176 |
* @return KErrNotFound if no conflicting entries, KErrNone otherwise.
|
|
177 |
*/
|
|
178 |
virtual TInt FetchConflictingEntriesL(
|
|
179 |
RPointerArray<CCalEntry>& aEntryArray ) = 0;
|
|
180 |
|
|
181 |
/**
|
|
182 |
* Tests if meeting request entry contains synchronization object.
|
|
183 |
* @return ETrue, if sync object is present
|
|
184 |
*/
|
|
185 |
virtual TBool IsSyncObjectPresent() const = 0;
|
|
186 |
|
|
187 |
/**
|
|
188 |
* Fetches the reference to sync object If sync object is not
|
|
189 |
* present, method leaves with KErrNotSupported.
|
|
190 |
*/
|
|
191 |
virtual MMRInfoObject& SyncObjectL() = 0;
|
|
192 |
|
|
193 |
/**
|
|
194 |
* Validates the sync object and return pointer to it. If sync object is not
|
|
195 |
* present, method leaves with KErrNotSupported.
|
|
196 |
*/
|
|
197 |
virtual MMRInfoObject& ValidateSyncObjectL() = 0;
|
|
198 |
|
|
199 |
/**
|
|
200 |
* Fetches startup parameters. Return ETrue if startup parameters
|
|
201 |
* were filled to aStarupParams structure.
|
|
202 |
* @param aStarupParams Reference to startup params structure
|
|
203 |
* @return ETrue, if startup params were present
|
|
204 |
*/
|
|
205 |
virtual TBool StartupParameters(
|
|
206 |
TESMRInputParams& aStarupParams) const = 0;
|
|
207 |
|
|
208 |
/**
|
|
209 |
* Fetches attendee count.
|
|
210 |
*
|
|
211 |
* Filtering flags is combimnation of enumeration TESMRRole values.
|
|
212 |
* For example, aFilterFlags = EESMRRoleRequiredAttendee --> Required
|
|
213 |
* attendee count is returns.
|
|
214 |
*
|
|
215 |
* @return Attendee count
|
|
216 |
*/
|
|
217 |
virtual TInt AttendeeCountL(
|
|
218 |
TUint aFilterFlags ) const = 0;
|
|
219 |
|
|
220 |
/**
|
|
221 |
* Tests, if entry is opened from mail.
|
|
222 |
* @return ETrue if entry is opened from mail.
|
|
223 |
*/
|
|
224 |
virtual TBool IsOpenedFromMail() const = 0;
|
|
225 |
|
|
226 |
/**
|
|
227 |
* Fetches attendees from entry. Attendees are added to
|
|
228 |
* aAttendeeArray. Attendees are filtered according to aFilterFlags
|
|
229 |
* parameter.
|
|
230 |
* Filtering flags is combimnation of enumeration TESMRRole values.
|
|
231 |
* For example, aFilterFlags = EESMRRoleRequiredAttendee --> Required
|
|
232 |
* attendees are included to array. Ownership of the attendee objects is
|
|
233 |
* not transferred.
|
|
234 |
* @param aAttendeeArray Reference to attendee array
|
|
235 |
* @param aFilterFlags Attendee filtering flags.
|
|
236 |
*/
|
|
237 |
virtual void GetAddedAttendeesL(
|
|
238 |
RArray<CCalAttendee*>& aAttendeeArray,
|
|
239 |
TUint aFilterFlags ) const = 0;
|
|
240 |
|
|
241 |
/**
|
|
242 |
* Fetches attendees from entry. Attendees are added to
|
|
243 |
* aAttendeeArray. Attendees are filtered according to aFilterFlags
|
|
244 |
* parameter.
|
|
245 |
* Filtering flags is combimnation of enumeration TESMRRole values.
|
|
246 |
* For example, aFilterFlags = EESMRRoleRequiredAttendee --> Required
|
|
247 |
* attendees are included to array. Ownership of the attendee objects is
|
|
248 |
* not transferred.
|
|
249 |
* @param aAttendeeArray Reference to attendee array
|
|
250 |
* @param aFilterFlags Attendee filtering flags.
|
|
251 |
*/
|
|
252 |
virtual void GetRemovedAttendeesL(
|
|
253 |
RArray<CCalAttendee*>& aAttendeeArray,
|
|
254 |
TUint aFilterFlags ) const = 0;
|
|
255 |
|
|
256 |
/**
|
|
257 |
* Updates child entries sequence numbers and stores them to
|
|
258 |
* calendar DB.
|
|
259 |
*/
|
|
260 |
virtual void UpdateChildEntriesSeqNumbersL() = 0;
|
|
261 |
|
|
262 |
/**
|
|
263 |
* Resolves current plugin in use.
|
|
264 |
* @return current plug-in in use.
|
|
265 |
*/
|
|
266 |
virtual TESMRMailPlugin CurrentPluginL() = 0;
|
|
267 |
|
|
268 |
/**
|
|
269 |
* Checks if any instance (having same UID)
|
|
270 |
* occurs between specified time. Time information
|
|
271 |
* is considered to be device's local time.
|
|
272 |
*
|
|
273 |
* @param aStart Start time
|
|
274 |
* @param aEnd End time
|
|
275 |
*/
|
|
276 |
virtual TBool AnyInstancesBetweenTimePeriodL(
|
|
277 |
TTime& aStart,
|
|
278 |
TTime& aEnd ) = 0;
|
|
279 |
|
|
280 |
/**
|
|
281 |
* Fetches first instances start and end time. For non-recurrent
|
|
282 |
* entries this returns the entry's start and end time.
|
|
283 |
*
|
|
284 |
* @param aStart On returns contains the first instance's start time.
|
|
285 |
* @param aEnd On returns contains the first instance's end time.
|
|
286 |
*/
|
|
287 |
virtual void GetFirstInstanceStartAndEndTimeL(
|
|
288 |
TTime& aStart,
|
|
289 |
TTime& aEnd ) = 0;
|
|
290 |
|
|
291 |
/**
|
|
292 |
* Fetches the calendar owner address.
|
|
293 |
* @return Calendar owner address
|
|
294 |
*/
|
|
295 |
virtual const TDesC& CalendarOwnerAddressL() const = 0;
|
|
296 |
|
|
297 |
/**
|
|
298 |
* Gets the mailbox utils.
|
|
299 |
*/
|
|
300 |
virtual CMRMailboxUtils& MailboxUtils() const = 0;
|
|
301 |
|
|
302 |
/**
|
|
303 |
* check whether can send canellation
|
|
304 |
*/
|
|
305 |
virtual TBool SendCanellationAvailable() = 0;
|
|
306 |
/**
|
|
307 |
* set the cannellation flag
|
|
308 |
*/
|
|
309 |
virtual void SetSendCanellationAvailable (TBool aSendCanellation) = 0;
|
|
310 |
};
|
|
311 |
|
|
312 |
#endif // MESMREMEETINGREQUESTSENDER_H
|