CPosLmIdListCriteria Class Reference

API published in: S60 3rd Ed

Link against: eposlmsearchlib.lib eposlmmultidbsearch.lib

Capability Information

Required Capabilities

None

Exceptions

The capability ReadUserData is required in:

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLandmarkSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartLandmarkSearchL( const CPosLmSearchCriteria & aCriteria, const TPosLmSortPref & aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

CPosLmMultiDbSearch::StartCategorySearchL( const CPosLmSearchCriteria & aCriteria, CPosLmCategoryManager::TCategorySortPref aSortPref, TBool aSearchOnlyPreviousMatches = EFalse );

Other Information

The capability NetworkServices is required to work with remote databases.

#include <epos_cposlmidlistcriteria.h>

Inherits 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.


Public Member Functions
virtual IMPORT_C  ~CPosLmIdListCriteria ()
  Destructor.
IMPORT_C void  SetLandmarkIdsL (const RArray< TPosLmItemId > &aIdArray)
  Sets the IDs of the landmarks which should be included in the search.
IMPORT_C void  GetLandmarkIdsL (RArray< TPosLmItemId > &aIdArray) const
  Retrieves the list of IDs of the landmarks which should be included in the search.

Static Public Member Functions
static IMPORT_C CPosLmIdListCriteria *  NewLC ()
  Two-phased constructor.

Constructor & Destructor Documentation

virtual IMPORT_C CPosLmIdListCriteria::~CPosLmIdListCriteria (   )  [virtual]
 

Destructor.

Member Function Documentation

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

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

Parameters:
[out]  aIdArray  On return, contains the IDs of the landmarks which should be included in the search.
static IMPORT_C CPosLmIdListCriteria* CPosLmIdListCriteria::NewLC (   )  [static]
 

Two-phased constructor.

Returns:
A new instance of this class.
IMPORT_C void CPosLmIdListCriteria::SetLandmarkIdsL (  const RArray< TPosLmItemId > &  aIdArray  ) 
 

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

Parameters:
[in]  aIdArray  The IDs of the landmarks which should be included in the search.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top