Collapse all Symbian^3 Application Developer Library

CPosLmCompositeCriteria Class Reference

class CPosLmCompositeCriteria : public CPosLmSearchCriteria

Class used to combine multiple search criterion.

For instance, to search for all restaurants in the area, this class can be used to combine a CPosLmAreaCriteria and a CPosLmCategoryCriteria .

If a CPosLmNearestCriteria is used and no sort preference is specified, the result will be sorted by distance. If more than one CPosLmNearestCriteria are combined using a CPosLmCompositeCriteria , the sort order will be undefined unless a sort preference is specified.

Nested CPosLmCompositeCriteria are not allowed.

This criterion only supports searching for landmarks, e.g. if it is passed to CPosLandmarkSearch::StartCategorySearchL , the function will fail with error code KErrNotSupported .

eposlmsearchlib.lib

Since: S60 3.0

Inherits from

CPosLmCompositeCriteria
- CPosLmSearchCriteria
  - CBase

Public Member Functions
	~CPosLmCompositeCriteria ()
IMPORT_C TInt	AddArgument ( CPosLmSearchCriteria *)
IMPORT_C const CPosLmSearchCriteria &	Argument ( TUint )
IMPORT_C CPosLmSearchCriteria &	Argument ( TUint )
IMPORT_C void	ClearArguments ()
IMPORT_C TCompositionType	CompositionType ()
IMPORT_C CPosLmCompositeCriteria *	NewLC ( TCompositionType )
IMPORT_C TUint	NumOfArguments ()
IMPORT_C CPosLmSearchCriteria *	RemoveArgument ( TUint )
IMPORT_C void	SetCompositionType ( TCompositionType )

Private Member Functions
	CPosLmCompositeCriteria ( TCompositionType )
	CPosLmCompositeCriteria (const CPosLmCompositeCriteria &)
void	ConstructL ()
CPosLmCompositeCriteria &	operator= (const CPosLmCompositeCriteria &)

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

Public Member Enumerations
enum	TCompositionType { ECompositionAND = 0, ECompositionOR = 1 }

Inherited Enumerations
	CPosLmSearchCriteria:TCriteriaType

Private Attributes
RPointerArray < CPosLmSearchCriteria >	iArguments
TCompositionType	iCompositionType

Constructor & Destructor Documentation

CPosLmCompositeCriteria(TCompositionType)

CPosLmCompositeCriteria

(

TCompositionType

aType

)

[private]

Parameters

TCompositionType aType

CPosLmCompositeCriteria(const CPosLmCompositeCriteria &)

CPosLmCompositeCriteria

(

const CPosLmCompositeCriteria &

)

[private]

Parameters

const CPosLmCompositeCriteria &

~CPosLmCompositeCriteria()

~CPosLmCompositeCriteria

(

)

[virtual]

Destructor.

Member Functions Documentation

AddArgument(CPosLmSearchCriteria *)

IMPORT_C TInt

AddArgument

(

CPosLmSearchCriteria *

aCriteria

)

Adds a criterion to this composition.

The composite criterion must contain at least one argument, otherwise CPosLandmarkSearch::StartLandmarkSearchL will fail with error code KErrArgument .

If this function returns without an error code, ownership of the added criterion object is transferred to the composite object.

CPosLmCompositeCriteria are not supported when composition type is ECompositionAND . Only CPosLmTextCriteria is supported in the case of ECompositionOR

Searching for landmark categories using CPosLmCompositeCriteria is not supported in the case of ECompositionAND.

Parameters

CPosLmSearchCriteria * aCriteria

The criterion to add to the composition.

Argument(TUint)

IMPORT_C const CPosLmSearchCriteria &

Argument

(

TUint

aIndex

)

const

Returns a criterion argument contained in this object.

This overload returns a const reference to the criterion argument. There is another overload which returns a non-const reference.

Parameters

TUint aIndex

The argument to read. Must be in the interval [0, NumOfArguments - 1], or this function will raise a USER-130 panic.

Argument(TUint)

IMPORT_C CPosLmSearchCriteria &

Argument

(

TUint

aIndex

)

Returns a criterion argument contained in this object.

This overload returns a non-const reference to the criterion argument. There is another overload which returns a const reference.

Parameters

TUint aIndex

The argument to read. Must be in the interval [0, NumOfArguments - 1], or this function will raise a USER-130 panic.

ClearArguments()

IMPORT_C void

ClearArguments

(

)

Removes and deletes all contained criterion objects.

The composite criterion must contain at least one argument, otherwise CPosLandmarkSearch::StartLandmarkSearchL will fail with error code KErrArgument .

CompositionType()

IMPORT_C TCompositionType

CompositionType

(

)

const

Returns the type of this composite criterion.

ConstructL()

void

ConstructL

(

)

[private]

NewLC(TCompositionType)

IMPORT_C CPosLmCompositeCriteria *

NewLC

(

TCompositionType

aType

)

[static]

Two-phased constructor.

Parameters

TCompositionType aType

The composition type to use.

NumOfArguments()

IMPORT_C TUint

NumOfArguments

(

)

const

Returns the number of criteria this object contains.

RemoveArgument(TUint)

IMPORT_C CPosLmSearchCriteria *

RemoveArgument

(

TUint

aIndex

)

Removes a criterion from this composition.

Note: This function does not delete the criterion object. Instead, the ownership of the object is passed to the caller.

Parameters

TUint aIndex

The argument to remove. Must be in the interval [0, NumOfArguments - 1], or this function will raise a USER-130 panic.

SetCompositionType(TCompositionType)

IMPORT_C void

SetCompositionType

(

TCompositionType

aType

)

Set the type of this composite criterion.

Parameters

TCompositionType aType

operator=(const CPosLmCompositeCriteria &)

CPosLmCompositeCriteria &

operator=

(

const CPosLmCompositeCriteria &

)

[private]

Parameters

const CPosLmCompositeCriteria &

Member Enumerations Documentation

Enum TCompositionType

Specifies the type of the composite criterion. ECompositionOR - is supported only when all the contained critarias are CPosLmTextCriteria . it is not supported for other criteria.

Enumerators

ECompositionAND = 0

Search results must match all contained criteria.

ECompositionOR = 1

Search result must match one of the contained criteria

ECompositionOR - is supported only when all the contained critarias are CPosLmTextCriteria . it is not supported for other criteria

Member Data Documentation

RPointerArray< CPosLmSearchCriteria > iArguments

RPointerArray < CPosLmSearchCriteria >

iArguments

[private]

TCompositionType iCompositionType

TCompositionType

iCompositionType

[private]