Collapse all Symbian^3 Product Developer Library

MESMRCalEntry Class Reference

class MESMRCalEntry

MESMRMeetingRequestEntry provides utility functions for handling MR Entry.

esmrservices.lib

Public Member Functions
	~MESMRCalEntry()
TBool	AnyInstancesBetweenTimePeriodL(TTime &, TTime &)
TBool	CanSetRecurrenceL()
CCalEntry *	CloneEntryLC(TESMRCalEntryType)
TBool	ContainsRemoteAttachmentsL()
const CCalEntry &	Entry()
CCalEntry &	Entry()
void	GetAlarmL(TESMRAlarmType &, TTime &)
MESMRCalDbMgr &	GetDBMgr()
void	GetFirstInstanceStartAndEndTimeL(TTime &, TTime &)
TUint	GetPriorityL()
void	GetRecurrenceL(TESMRRecurrenceValue &, TTime &)
CCalInstance *	InstanceL()
TBool	IsAllDayEventL()
TBool	IsEntryEditedL()
TBool	IsEntryTypeChangedL()
TBool	IsRecurrentEventL()
TBool	IsStoredL()
MESMRCalEntry &	MESMRCalEntryRef()
const MESMRCalEntry &	MESMRCalEntryRef()
const CCalEntry &	OriginalEntry()
TESMRRecurrenceModifyingRule	RecurrenceModRule()
CCalEntry *	RemoveInstanceFromSeriesL()
void	SetAllDayEventL(TTime, TTime)
void	SetDefaultValuesToEntryL()
void	SetModifyingRuleL(TESMRRecurrenceModifyingRule, const TBool)
void	SetPriorityL(TUint)
void	SetRecurrenceL(TESMRRecurrenceValue, TTime)
void	SetTypeChanged(TBool)
TBool	SupportsCapabilityL(TMREntryCapability)
TESMRCalEntryType	Type()
void	UpdateComparativeEntry(CCalEntry *)
void	UpdateEntryAfterStoringL()
void	UpdateTimeStampL()
CCalEntry *	ValidateEntryL()

Public Member Enumerations
enum	TESMRAlarmType { EESMRAlarmNotFound, EESMRAlarmAbsolute, EESMRAlarmRelative }
enum	TESMRCalEntryType { EESMRCalEntryNotSupported = EESMREventTypeNone, EESMRCalEntryMeetingRequest = EESMREventTypeMeetingRequest, EESMRCalEntryMeeting = EESMREventTypeAppt, EESMRCalEntryTodo = EESMREventTypeETodo, EESMRCalEntryMemo = EESMREventTypeEEvent, EESMRCalEntryReminder = EESMREventTypeEReminder, EESMRCalEntryAnniversary = EESMREventTypeEAnniv }
enum	TESMRRecurrenceModifyingRule { EESMRThisOnly, EESMRAllInSeries }
enum	TMREntryCapability { EMRCapabilityAttachments }

Constructor & Destructor Documentation

~MESMRCalEntry()

~MESMRCalEntry

(

)

[inline, virtual]

Virtual destructor.

Member Functions Documentation

AnyInstancesBetweenTimePeriodL(TTime &, TTime &)

TBool	AnyInstancesBetweenTimePeriodL	(	TTime &	aStart,
			TTime &	aEnd
		)	[pure virtual]

Checks if any instance (having same UID) occurs between specified time. Time information is considered to be device's local time.

Parameters

TTime & aStart	Start time
TTime & aEnd	End time

CanSetRecurrenceL()

TBool

CanSetRecurrenceL

(

)

const [pure virtual]

Tests, if recurrence can be set.

CloneEntryLC(TESMRCalEntryType)

CCalEntry *

CloneEntryLC

(

TESMRCalEntryType

aType = EESMRCalEntryNotSupported

)

const [pure virtual]

Clones entry and leaves the clone into CleanupStack.

Parameters

TESMRCalEntryType aType = EESMRCalEntryNotSupported

the entry type of the clone. If EESMRCalEntryNotSupported the original type is preserved.

ContainsRemoteAttachmentsL()

TBool

ContainsRemoteAttachmentsL

(

)

[pure virtual]

Tests whether entry contains remote attachments or not.

Entry()

const CCalEntry &

Entry

(

)

const [pure virtual]

Fetches constant reference to CCalEntry.

Entry()

CCalEntry &

Entry

(

)

[pure virtual]

Fetches reference to CCalEntry.

GetAlarmL(TESMRAlarmType &, TTime &)

void	GetAlarmL	(	TESMRAlarmType &	aAlarmType,
			TTime &	aAlarmTime
		)	[pure virtual]

Fetches alarm information from entry.

Parameters

TESMRAlarmType & aAlarmType	On return contains alarm type.
TTime & aAlarmTime	On return contains time when alarm occurs.

GetDBMgr()

MESMRCalDbMgr &

GetDBMgr

(

)

[pure virtual]

Get calendar dbmgr

GetFirstInstanceStartAndEndTimeL(TTime &, TTime &)

void	GetFirstInstanceStartAndEndTimeL	(	TTime &	aStart,
			TTime &	aEnd
		)	[pure virtual]

Fetches first instances start and end time. For non-recurrent entries this returns the entry's start and end time.

Parameters

TTime & aStart	On returns contains the first instance's start time.
TTime & aEnd	On returns contains the first instance's end time.

GetPriorityL()

TUint

GetPriorityL

(

)

const [pure virtual]

Fetches the entry priority.

GetRecurrenceL(TESMRRecurrenceValue &, TTime &)

void	GetRecurrenceL	(	TESMRRecurrenceValue &	aRecurrence,
			TTime &	aUntil
		)	const [pure virtual]

Fetches entry's recurrence value.

Parameters

TESMRRecurrenceValue & aRecurrence	On return contains entry's recurrence information
TTime & aUntil	On return contains time in UTC until recurrence is valid.

InstanceL()

CCalInstance *

InstanceL

(

)

const [pure virtual]

Fetches calendar entry's instance. Ownership is transferred to caller.

IsAllDayEventL()

TBool

IsAllDayEventL

(

)

const [pure virtual]

Tests, if entry is all day event.

IsEntryEditedL()

TBool

IsEntryEditedL

(

)

const [pure virtual]

Tests, whether entry is edited.

IsEntryTypeChangedL()

TBool

IsEntryTypeChangedL

(

)

const [pure virtual]

Tests, if entry type has changed from the original

IsRecurrentEventL()

TBool

IsRecurrentEventL

(

)

const [pure virtual]

Tests, if this is recurrent meeting request.

IsStoredL()

TBool

IsStoredL

(

)

const [pure virtual]

Tests whether this entry has been stored to db or not.

MESMRCalEntryRef()

MESMRCalEntry &

MESMRCalEntryRef

(

)

[pure virtual]

Fetches reference to this calendar entry.

MESMRCalEntryRef()

const MESMRCalEntry &

MESMRCalEntryRef

(

)

const [pure virtual]

Fetches const reference to this calendar entry.

OriginalEntry()

const CCalEntry &

OriginalEntry

(

)

[pure virtual]

Fetches unmodified entry instance.

RecurrenceModRule()

TESMRRecurrenceModifyingRule

RecurrenceModRule

(

)

const [pure virtual]

Fetches recurrence modification rule.

RemoveInstanceFromSeriesL()

CCalEntry *

RemoveInstanceFromSeriesL

(

)

[pure virtual]

For recurrent event method removes this from the series. Entry needs to be recurrent event and modification rule needs to be MESMRCalEntry::EESMRThisOnly. Ownership of the returned calendar entry is transferred to caller.

SetAllDayEventL(TTime, TTime)

void	SetAllDayEventL	(	TTime	aStartDate,
			TTime	aEndDate
		)	[pure virtual]

Sets meeting to be all day event.

Parameters

TTime aStartDate	Start date information
TTime aEndDate	End date information

SetDefaultValuesToEntryL()

void

SetDefaultValuesToEntryL

(

)

[pure virtual]

Sets default values to entry.

SetModifyingRuleL(TESMRRecurrenceModifyingRule, const TBool)

void	SetModifyingRuleL	(	TESMRRecurrenceModifyingRule	aRule,
			const TBool	aTypeChanging = EFalse
		)	[pure virtual]

Sets modifying rule role to meeting request.

Parameters

TESMRRecurrenceModifyingRule aRule	ETrue event type is changing.
const TBool aTypeChanging = EFalse

SetPriorityL(TUint)

void

SetPriorityL

(

TUint

aPriority

)

[pure virtual]

Sets the entry priority.

Parameters

TUint aPriority

entry priority.

SetRecurrenceL(TESMRRecurrenceValue, TTime)

void	SetRecurrenceL	(	TESMRRecurrenceValue	aRecurrence,
			TTime	aUntil = Time::NullTTime()
		)	[pure virtual]

Sets recurrence to ES MR entry. If until time is not set (i.e, it is null time), then until time is implementation dependent. When recurrence is set to ERecurrenceNot, then aUntil parameter is ignored.

Parameters

TESMRRecurrenceValue aRecurrence
TTime aUntil = Time::NullTTime()	Recurrence valid until in UTC format. KErrNotSupported Entry cannot be recurrenced.

SetTypeChanged(TBool)

void

SetTypeChanged

(

TBool

aTypeChanged

)

[pure virtual]

Sets the entry type changed

Parameters

TBool aTypeChanged

SupportsCapabilityL(TMREntryCapability)

TBool

SupportsCapabilityL

(

TMREntryCapability

aCapability

)

const [pure virtual]

Tests whether entry supports capability or not.

Parameters

TMREntryCapability aCapability

Capability to be checked

Type()

TESMRCalEntryType

Type

(

)

const [pure virtual]

Fetches calendar entry type.

UpdateComparativeEntry(CCalEntry *)

void

UpdateComparativeEntry

(

CCalEntry *

aNewComparativeEntry

)

[pure virtual]

Updates the comparative entry (needed in entry type changing)

Parameters

CCalEntry * aNewComparativeEntry

UpdateEntryAfterStoringL()

void

UpdateEntryAfterStoringL

(

)

[pure virtual]

Updates the entry after storing

UpdateTimeStampL()

void

UpdateTimeStampL

(

)

[pure virtual]

Updates entry's timestamp (DTSTAMP) information.

ValidateEntryL()

CCalEntry *

ValidateEntryL

(

)

[pure virtual]

Fetches validated entry. Ownership is transferred to caller.

Member Enumerations Documentation

Enum TESMRAlarmType

Enumeration for alarm type

Enumerators

EESMRAlarmNotFound	Entry does not contain alarm
EESMRAlarmAbsolute	Alarm is absolute
EESMRAlarmRelative	Alarm is relative to meeting start time

Enum TESMRCalEntryType

Enumeration for cal entry type

Enumerators

EESMRCalEntryNotSupported = EESMREventTypeNone
EESMRCalEntryMeetingRequest = EESMREventTypeMeetingRequest
EESMRCalEntryMeeting = EESMREventTypeAppt
EESMRCalEntryTodo = EESMREventTypeETodo
EESMRCalEntryMemo = EESMREventTypeEEvent
EESMRCalEntryReminder = EESMREventTypeEReminder
EESMRCalEntryAnniversary = EESMREventTypeEAnniv

Enum TESMRRecurrenceModifyingRule

Enumeration for recurrence modifying rule

Enumerators

EESMRThisOnly
EESMRAllInSeries

Enum TMREntryCapability

Enumeration for entry

Enumerators

EMRCapabilityAttachments