CMsvEntryFilter Class Reference

#include <mw/msvstd.h>

Link against: msgs_autoshutdown.lib

class CMsvEntryFilter : public CBase, public CBase, public CBase

Inherits from

CMsvEntryFilter

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()

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()

Detailed Description

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.

Member Function Documentation

LastChangeDate ( )

const TTime &

LastChangeDate

(

)

const [inline]

Gets the last change date set for the filter.

Return Value: Last change date set for the filter

Mtm ( )

TUid

Mtm

(

)

const [inline]

Gets the MTM UID set for the filter.

Return Value: 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.

Return Value: Pointer to the newly created entry filter.

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.

Return Value: Pointer to the newly created entry filter.

Order ( )

const TMsvSelectionOrdering &

Order

(

)

const [inline]

Gets the selection ordering set for the filter.

Return Value: Selection ordering set for the filter

Service ( )

TMsvId

Service

(

)

const [inline]

Gets the service ID set for the filter.

Return Value: 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
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
aMtm	MTM UID for the filter

SetOrder ( const TMsvSelectionOrdering & )

void

SetOrder

(

const TMsvSelectionOrdering &

aOrder

)

[inline]

Sets the sort ordering for the filter.

Parameters
aOrder	Selection ordering for the filter

SetService ( TMsvId )

void

SetService

(

TMsvId

aServiceId

)

[inline]

Sets the service ID for the filter.

Parameters
aServiceId	Service ID for the filter

SetSortMtm ( TUid )

void

SetSortMtm

(

TUid

aSortMtm

)

[inline]

Sets the sorting by MTM for the filter.

Parameters
aSortMtm	Sorting by MTM for the filter

SetType ( TUid )

void

SetType

(

TUid

aType

)

[inline]

Sets the entry type for the filter.

Parameters
aType	Entry type for the filter

SortMtm ( )

TUid

SortMtm

(

)

const [inline]

Gets the sorting by MTM for the filter.

Return Value: Sorting by MTM for the filter

Type ( )

TUid

Type

(

)

const [inline]

Gets the entry type set for the filter.

Return Value: Entry type set for the filter