Collapse all Symbian^3 Product Developer Library

MESMRCalDbMgr Class Reference

class MESMRCalDbMgr : public MCalProgressCallBack

MESMRServicesCalDbMgr defines interface for calendar DB operations.

esmrservices.lib

Inherits from

MESMRCalDbMgr
- MCalProgressCallBack

Public Member Functions
	~MESMRCalDbMgr()
CCalSession &	CalSession()
void	DeleteEntryCondL(const TDesC8 &)
void	DeleteEntryCondL(const TCalLocalUid &)
void	DeleteEntryCondL(const CCalEntry &)
void	DeleteEntryCondL(const CalCommon::TCalTimeRange &)
TInt	DeleteEntryL(const TDesC8 &, TInt)
TInt	DeleteEntryL(const TCalLocalUid &, TInt)
CCalEntryView *	EntryView()
CCalEntryView *	EntryViewL(const CCalEntry &)
void	FetchEntriesL(RPointerArray< CCalEntry > &, const CalCommon::TCalTimeRange &)
CCalEntry *	FetchEntryL(const TDesC8 &, const TCalTime &)
CCalInstance *	FindInstanceL(const CCalEntry &)
TRgb	GetCalendarColorByEntryL(MESMRCalEntry &)
TRgb	GetCalendarColorByNameL(const TDesC &)
TPtrC	GetCalendarNameByEntryL(MESMRCalEntry &)
TInt	GetCurCalendarColIdL()
TRgb	GetCurCalendarColor()
TInt	GetCurCalendarIndex()
void	GetMultiCalendarNameListL(RArray< TPtrC > &)
CCalInstanceView *	InstanceViewL(const CCalEntry &)
RPointerArray< CCalInstanceView >	NormalDbAllCalenInstanceView()
CCalEntryView *	NormalDbEntryView()
CCalInstanceView *	NormalDbInstanceView()
void	SetCurCalendarByColIdL(TInt)
void	SetCurCalendarByDbIdL(TCalFileId)
void	SetCurCalendarByEntryL(MESMRCalEntry &)
void	SetCurCalendarByIndex(TInt)
void	SetCurCalendarByNameL(const TDesC &)
MESMRUtilsTombsExt::TESMRUtilsDbResult	StoreEntryCondL(CCalEntry &, TBool, TBool)
TInt	StoreEntryL(CCalEntry &, TBool)
TInt	UpdateEntryL(const CCalEntry &)

Inherited Functions
	MCalProgressCallBack::Completed(TInt)
	MCalProgressCallBack::NotifyProgress()
	MCalProgressCallBack::Progress(TInt)

Constructor & Destructor Documentation

~MESMRCalDbMgr()

~MESMRCalDbMgr

(

)

[inline, virtual]

Destructor.

Member Functions Documentation

CalSession()

CCalSession &

CalSession

(

)

[pure virtual]

Fetches the calendar session associated with this cal db manager.

DeleteEntryCondL(const TDesC8 &)

void

DeleteEntryCondL

(

const TDesC8 &

aUid

)

[pure virtual]

Delete entry from Agenda Model if found This method causes deletion of all entries with given GUID.

Parameters

const TDesC8 & aUid

determines entry to be deleted

DeleteEntryCondL(const TCalLocalUid &)

void

DeleteEntryCondL

(

const TCalLocalUid &

aLocalUid

)

[pure virtual]

Delete entry from Agenda Model if found. This method causes deletion of a modifying entry, or entire recurring event if aLocalUid corresponds to an originating entry.

Parameters

const TCalLocalUid & aLocalUid

determines entry to be deleted

DeleteEntryCondL(const CCalEntry &)

void

DeleteEntryCondL

(

const CCalEntry &

aCalEntry

)

[pure virtual]

Delete entry from Agenda Model if found. This method causes deletion of a modifying entry, or entire recurring event if aCalEntry is an originating entry.

Parameters

const CCalEntry & aCalEntry

entry to be deleted

DeleteEntryCondL(const CalCommon::TCalTimeRange &)

void

DeleteEntryCondL

(

const CalCommon::TCalTimeRange &

aCalTimeRange

)

[pure virtual]

Delete entries from Agenda Model if found. This is asynchronous, user gets notified with MMRUtilsObserver::HandleOperation( EDeleteEntries,... )

Parameters

const CalCommon::TCalTimeRange & aCalTimeRange

determines entries to be deleted

DeleteEntryL(const TDesC8 &, TInt)

TInt	DeleteEntryL	(	const TDesC8 &	aUid,
			TInt	aCalenIndex
		)	[pure virtual]

Deletes the given entry from the Agenda Model.

Parameters

const TDesC8 & aUid	Entry uid to be deleted
TInt aCalenIndex

DeleteEntryL(const TCalLocalUid &, TInt)

TInt	DeleteEntryL	(	const TCalLocalUid &	aLocalUid,
			TInt	aCalenIndex
		)	[pure virtual]

Deletes the given entry from the Agenda Model.

Parameters

const TCalLocalUid & aLocalUid	Entry uid to be deleted
TInt aCalenIndex

EntryView()

CCalEntryView *

EntryView

(

)

[pure virtual]

EntryViewL(const CCalEntry &)

CCalEntryView *

EntryViewL

(

const CCalEntry &

aCalEntry

)

[pure virtual]

Parameters

const CCalEntry & aCalEntry

FetchEntriesL(RPointerArray< CCalEntry > &, const CalCommon::TCalTimeRange &)

void	FetchEntriesL	(	RPointerArray< CCalEntry > &	aCalEntryArray,
			const CalCommon::TCalTimeRange &	aTimeRange
		)	[pure virtual]

Fetches entries from the Agenda Model based on time range. In case of repeating entries the entire sequence must be within range (but modifying entries are considered separately). Ownership of entries is transferred to caller. See CCalEntryView documentation for other fetch variants.

Parameters

RPointerArray< CCalEntry > & aCalEntryArray	will contain fetched entries
const CalCommon::TCalTimeRange & aTimeRange	criteria

FetchEntryL(const TDesC8 &, const TCalTime &)

CCalEntry *	FetchEntryL	(	const TDesC8 &	aUid,
			const TCalTime &	aRecurrenceId
		)	[pure virtual]

Fetches entry from the Agenda Model based on Uid and recurrence id. See CCalEntryView documentation for other fetch variants. For fetching originating entry use TCalTime set to Time::NullTTime(). Returns NULL if no matching entry was found.

Parameters

const TDesC8 & aUid	criteria
const TCalTime & aRecurrenceId	criteria

FindInstanceL(const CCalEntry &)

CCalInstance *

FindInstanceL

(

const CCalEntry &

aEntry

)

[pure virtual]

Finds matching calendar instance from calendar db. Ownership is transferred to caller. If instance cannot be found, NULL is returned.

Parameters

const CCalEntry & aEntry

Reference to calendar entry

GetCalendarColorByEntryL(MESMRCalEntry &)

TRgb

GetCalendarColorByEntryL

(

MESMRCalEntry &

aEntry

)

[pure virtual]

Get calendar's color by entry

Parameters

MESMRCalEntry & aEntry

Reference to calendar entry

GetCalendarColorByNameL(const TDesC &)

TRgb

GetCalendarColorByNameL

(

const TDesC &

aCalendarName

)

[pure virtual]

Get calendar's color by calendar name

Parameters

const TDesC & aCalendarName

Reference to calendar name

GetCalendarNameByEntryL(MESMRCalEntry &)

TPtrC

GetCalendarNameByEntryL

(

MESMRCalEntry &

aEntry

)

[pure virtual]

Get calendar's name by entry

Parameters

MESMRCalEntry & aEntry

Reference to calendar entry

GetCurCalendarColIdL()

TInt

GetCurCalendarColIdL

(

)

[pure virtual]

GetCurCalendarColor()

TRgb

GetCurCalendarColor

(

)

[pure virtual]

GetCurCalendarIndex()

TInt

GetCurCalendarIndex

(

)

[pure virtual]

GetMultiCalendarNameListL(RArray< TPtrC > &)

void

GetMultiCalendarNameListL

(

RArray< TPtrC > &

aCalendarNameList

)

[pure virtual]

Get multi-calendar name list

Parameters

RArray< TPtrC > & aCalendarNameList

Reference to name string array

InstanceViewL(const CCalEntry &)

CCalInstanceView *

InstanceViewL

(

const CCalEntry &

aCalEntry

)

[pure virtual]

Parameters

const CCalEntry & aCalEntry

NormalDbAllCalenInstanceView()

RPointerArray< CCalInstanceView >

NormalDbAllCalenInstanceView

(

)

[pure virtual]

Accessor for Agenda Model CCalInstanceView owned by this utility. Returns a valid array of pointer if status is EAvailable or EAvailableWithoutTombs, otherwise NULL.

NormalDbEntryView()

CCalEntryView *

NormalDbEntryView

(

)

[pure virtual]

Accessor for Agenda Model CCalEntryView owned by utility. Returns a valid pointer if status is EAvailable or EAvailableWithoutTombs, otherwise NULL.

NormalDbInstanceView()

CCalInstanceView *

NormalDbInstanceView

(

)

[pure virtual]

Accessor for Agenda Model CCalInstanceView owned by this utility. Returns a valid pointer if status is EAvailable or EAvailableWithoutTombs, otherwise NULL.

SetCurCalendarByColIdL(TInt)

void

SetCurCalendarByColIdL

(

TInt

aColId

)

[pure virtual]

Set current calendar by pass entry

Parameters

TInt aColId

current calendar collectionID

SetCurCalendarByDbIdL(TCalFileId)

void

SetCurCalendarByDbIdL

(

TCalFileId

aDbId

)

[pure virtual]

Sets current calendar by calendar database file id.

Parameters

TCalFileId aDbId

calendar database file id to use

SetCurCalendarByEntryL(MESMRCalEntry &)

void

SetCurCalendarByEntryL

(

MESMRCalEntry &

aEntry

)

[pure virtual]

Set current calendar by pass entry

Parameters

MESMRCalEntry & aEntry

entry which belongs current calendar

SetCurCalendarByIndex(TInt)

void

SetCurCalendarByIndex

(

TInt

aIndex

)

[pure virtual]

Set current calendar by pass calendar index to it

Parameters

TInt aIndex

current calendar index

SetCurCalendarByNameL(const TDesC &)

void

SetCurCalendarByNameL

(

const TDesC &

aCalendarName

)

[pure virtual]

Set current calendar by pass calendar name to it

Parameters

const TDesC & aCalendarName

current calendar name

StoreEntryCondL(CCalEntry &, TBool, TBool)

MESMRUtilsTombsExt::TESMRUtilsDbResult	StoreEntryCondL	(	CCalEntry &	aCalEntry,
			TBool	aResurrect,
			TBool	aCheckOnly = EFalse
		)	[pure virtual]

Check entry: GUID, sequence number, existence in Agenda Model and tombstone database. Same as CMRUtilsTombsExt::StoreL() but doesn't actually store.

Parameters

CCalEntry & aCalEntry	entry to be stored
TBool aResurrect
TBool aCheckOnly = EFalse

StoreEntryL(CCalEntry &, TBool)

TInt	StoreEntryL	(	CCalEntry &	aCalEntry,
			TBool	aToNormalDb = ETrue
		)	[pure virtual]

Stores the given entry in the Agenda Model. Entry is either stored to normal calendar DB or to tombstone calendar DB depending from input parameters.

Parameters

CCalEntry & aCalEntry	entry to be stored. aToNormalDb ETrue --> stored to normal DB. EFalse --> stored to tombstone calendar DB.
TBool aToNormalDb = ETrue

UpdateEntryL(const CCalEntry &)

TInt

UpdateEntryL

(

const CCalEntry &

aCalEntry

)

[pure virtual]

Updates the given entry in the Agenda Model.

Parameters

const CCalEntry & aCalEntry

entry to update