Collapse all Symbian^3 Application Developer Library

CMsvEntryFilter Class Reference

class CMsvEntryFilter : public CBase

Used to query the Message Server for entries that match the specification defined in the filter.

It allows a query to be performed on service, MTM, type and last change date. The filter also enables the specification of the order in which the entries are returned.

CMsvSession::GetChildIdsL()

Inherits from

CMsvEntryFilter
- CBase

Public Member Functions
const TTime &	LastChangeDate ()
TUid	Mtm ()
IMPORT_C CMsvEntryFilter *	NewL ()
IMPORT_C CMsvEntryFilter *	NewLC ()
const TMsvSelectionOrdering &	Order ()
TMsvId	Service ()
void	SetLastChangeDate (const TTime &)
void	SetMtm ( TUid )
void	SetOrder (const TMsvSelectionOrdering &)
void	SetService ( TMsvId )
void	SetSortMtm ( TUid )
void	SetType ( TUid )
TUid	SortMtm ()
TUid	Type ()

Private Member Functions
	CMsvEntryFilter ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TTime	iLastChange
TUid	iMtm
TMsvSelectionOrdering	iOrdering
TMsvId	iServiceId
TUid	iSortMtm
TUid	iType

Constructor & Destructor Documentation

CMsvEntryFilter()

CMsvEntryFilter

(

)

[private]

Member Functions Documentation

LastChangeDate()

const TTime &

LastChangeDate

(

)

const [inline]

Gets the last change date set for the filter.

Mtm()

TUid

Mtm

(

)

const [inline]

Gets the MTM UID set for the filter.

NewL()

IMPORT_C CMsvEntryFilter *

NewL

(

)

[static]

Allocates and constructs a new entry filter.

Default values are as follows:

1. service: KMsvNullIndexEntryId

2. MTM: KNullUid

3. entry type: KNullUid

4. last change date: no date

5. sort order defaults to EMsvSortByNone

These values mean that entries with any values for service, MTM, type and last change date will be returned, with no grouping or sort MTM.

NewLC()

IMPORT_C CMsvEntryFilter *

NewLC

(

)

[static]

Allocates and constructs a new entry filter, and leaves the pointer on the cleanup stack.

For default values, see the NewL() function.

Order()

const TMsvSelectionOrdering &

Order

(

)

const [inline]

Gets the selection ordering set for the filter.

Service()

TMsvId

Service

(

)

const [inline]

Gets the service ID set for the filter.

SetLastChangeDate(const TTime &)

void

SetLastChangeDate

(

const TTime &

aLastChange

)

[inline]

Sets the last date change for the filter.

This is used to retrieve entries that have changed since a particular date.

Parameters

const TTime & aLastChange

Last date change for the filter, specified in Universal Time (GMT)

SetMtm(TUid)

void

SetMtm

(

TUid

aMtm

)

[inline]

Sets the MTM UID for the filter.

Parameters

TUid aMtm

MTM UID for the filter

SetOrder(const TMsvSelectionOrdering &)

void

SetOrder

(

const TMsvSelectionOrdering &

aOrder

)

[inline]

Sets the sort ordering for the filter.

Parameters

const TMsvSelectionOrdering & aOrder

Selection ordering for the filter

SetService(TMsvId)

void

SetService

(

TMsvId

aServiceId

)

[inline]

Sets the service ID for the filter.

Parameters

TMsvId aServiceId

Service ID for the filter

SetSortMtm(TUid)

void

SetSortMtm

(

TUid

aSortMtm

)

[inline]

Sets the sorting by MTM for the filter.

Parameters

TUid aSortMtm

Sorting by MTM for the filter

SetType(TUid)

void

SetType

(

TUid

aType

)

[inline]

Sets the entry type for the filter.

Parameters

TUid aType

Entry type for the filter

SortMtm()

TUid

SortMtm

(

)

const [inline]

Gets the sorting by MTM for the filter.

Type()

TUid

Type

(

)

const [inline]

Gets the entry type set for the filter.

Member Data Documentation

TTime iLastChange

TTime

iLastChange

[private]

TUid iMtm

TUid

iMtm

[private]

TMsvSelectionOrdering iOrdering

TMsvSelectionOrdering

iOrdering

[private]

TMsvId iServiceId

TMsvId

iServiceId

[private]

TUid iSortMtm

TUid

iSortMtm

[private]

TUid iType

TUid

iType

[private]