CPosLmIdListCriteria Class Reference

#include <mw/EPos_CPosLmIdListCriteria.h>

Link against: eposlmsearchlib.lib

class CPosLmIdListCriteria : public CPosLmSearchCriteria

Inherits from

CPosLmIdListCriteria
- CPosLmSearchCriteria

Public Member Functions
virtual	~CPosLmIdListCriteria()
IMPORT_C void	GetLandmarkIdsL(RArray< TPosLmItemId > &)
IMPORT_C CPosLmIdListCriteria *	NewLC()
IMPORT_C void	SetLandmarkIdsL(const RArray< TPosLmItemId > &)

Inherited Enumerations
	CPosLmSearchCriteria:TCriteriaType

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()
	CPosLmSearchCriteria::CPosLmSearchCriteria(TCriteriaType)
	CPosLmSearchCriteria::CriteriaType()const
	CPosLmSearchCriteria::~CPosLmSearchCriteria()

Detailed Description

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.

Since: S60 3.0

Constructor & Destructor Documentation

~CPosLmIdListCriteria ( )

IMPORT_C

~CPosLmIdListCriteria

(

)

[virtual]

Destructor

Member Function 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.

Parameter	Description
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.

Returns: A new instance of this class.

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.

Parameter	Description
aIdArray	The IDs of the landmarks which should be included in the search.