CPosLmIdListCriteria Class Reference

class CPosLmIdListCriteria : public CPosLmSearchCriteria

Landmark ID list search criterion.

This criterion is used if the client only wants to search a subset of the landmarks in the database.

This criterion must be combined with other search criteria using a CPosLmCompositeCriteria . It is of no use on its own. If it is not combined with another criterion, CPosLandmarkSearch::StartLandmarkSearchL will fail with error code KErrArgument .

Example: If this criterion is combined with a CPosLmTextCriteria , the search operation searches the landmarks specified in the ID list criterion and returns those which match the given text string.

Only one ID list criterion is allowed in each composite criterion, otherwise CPosLandmarkSearch::StartLandmarkSearchL will fail with error code KErrArgument .

If the criterion does not contain any landmark IDs, CPosLandmarkSearch::StartLandmarkSearchL will fail with error code KErrArgument .

eposlmsearchlib.lib
Since
S60 3.0

Inherits from

Constructor & Destructor Documentation

CPosLmIdListCriteria()

CPosLmIdListCriteria ( ) [private]

CPosLmIdListCriteria(const CPosLmIdListCriteria &)

CPosLmIdListCriteria ( const CPosLmIdListCriteria & ) [private]

Parameters

const CPosLmIdListCriteria &

~CPosLmIdListCriteria()

IMPORT_C ~CPosLmIdListCriteria ( ) [virtual]

Destructor

Member Functions Documentation

GetLandmarkIdsL(RArray< TPosLmItemId > &)

IMPORT_C void GetLandmarkIdsL ( RArray < TPosLmItemId > & aIdArray ) const

Retrieves the list of IDs of the landmarks which should be included in the search.

Parameters

RArray < TPosLmItemId > & aIdArray On return, contains the IDs of the landmarks which should be included in the search.

NewLC()

IMPORT_C CPosLmIdListCriteria * NewLC ( ) [static]

Two-phased constructor.

SetLandmarkIdsL(const RArray< TPosLmItemId > &)

IMPORT_C void SetLandmarkIdsL ( const RArray < TPosLmItemId > & aIdArray )

Sets the IDs of the landmarks which should be included in the search.

Parameters

const RArray < TPosLmItemId > & aIdArray The IDs of the landmarks which should be included in the search.

operator=(const CPosLmIdListCriteria &)

CPosLmIdListCriteria & operator= ( const CPosLmIdListCriteria & ) [private]

Parameters

const CPosLmIdListCriteria &

Member Data Documentation

RArray< TPosLmItemId > iIdArray

RArray < TPosLmItemId > iIdArray [private]