Class CMsvEntryFilter

CMsvEntryFilter

Support

Supported from 6.0

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.

Derivation

CBase Base class for all classes to be instantiated on the heap CMsvEntryFilter Used to query the Message Server for entries that match the specification defined in the filter

Defined in CMsvEntryFilter:
LastChangeDate(), Mtm(), NewL(), NewLC(), Order(), Service(), SetLastChangeDate(), SetMtm(), SetOrder(), SetService(), SetSortMtm(), SetType(), SortMtm(), Type()

Inherited from CBase:
operator new()

See also:

• CMsvSession::GetChildIdsL()

static CMsvEntryFilter* NewL();

Description

Allocates and constructs a new entry filter.

Default values are as follows:

• service: KMsvNullIndexEntryId

• MTM: KNullUid

• entry type: KNullUid

• last change date: no date

• 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

CMsvEntryFilter* Pointer to the newly created entry filter.

static CMsvEntryFilter* NewLC();

Description

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

For default values, see the NewL() function.

Return value

CMsvEntryFilter* Pointer to the newly created entry filter.

const TTime& LastChangeDate() const;

Description

Gets the last change date set for the filter.

Return value

const TTime& Last change date set for the filter

TUid Mtm() const;

Description

Gets the MTM UID set for the filter.

Return value

TUid MTM UID set for the filter

const TMsvSelectionOrdering& Order() const;

Description

Gets the selection ordering set for the filter.

Return value

const TMsvSelectionOrdering& Selection ordering set for the filter

TMsvId Service() const;
    

Description

Gets the service ID set for the filter.

Return value

TMsvId Service ID set for the filter

TUid SortMtm() const;

Description

Gets the sorting by MTM for the filter.

Return value

TUid Sorting by MTM for the filter

TUid Type() const;

Description

Gets the entry type set for the filter.

Return value

TUid Entry type set for the filter

void SetLastChangeDate(const TTime& aLastChange);

Description

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)

void SetMtm(TUid aMtm);

Description

Sets the MTM UID for the filter.

Parameters

TUid aMtm MTM UID for the filter

void SetOrder(const TMsvSelectionOrdering& aOrder);

Description

Sets the sort ordering for the filter.

Parameters

const TMsvSelectionOrdering& aOrder Selection ordering for the filter

void SetService(TMsvId aServiceId);

Description

Sets the service ID for the filter.

Parameters

TMsvId aServiceId Service ID for the filter

void SetSortMtm(TUid aSortMtm);

Description

Sets the sorting by MTM for the filter.

Parameters

TUid aSortMtm Sorting by MTM for the filter

void SetType(TUid aType);

Description

Sets the entry type for the filter.

Parameters

TUid aType Entry type for the filter