Collapse all Symbian^3 Application Developer Library

MSearchElement Class Reference

class MSearchElement : public MXIMPBase

Interface for search element object.

Inherits from

MSearchElement
- MXIMPBase

Public Member Functions
	~MSearchElement ()
MXIMPIdentity &	GetSearchId ()
TSearchKey	GetSearchKey ()
MXIMPIdentity &	GetSearchLabel ()
void	SetRequestL ( MXIMPIdentity &, TSearchKey )
void	SetRequestL ( MXIMPIdentity &, MXIMPIdentity &)

Inherited Functions
	MXIMPBase::GetInterface(TInt32,TIfGetOps)
	MXIMPBase::GetInterface(TInt32,TIfGetOps)const
	MXIMPBase::GetInterfaceId()const
	MXIMPBase::~MXIMPBase()

Inherited Enumerations
	MXIMPBase:@65
	MXIMPBase:TIfGetOps

Constructor & Destructor Documentation

~MSearchElement()

~MSearchElement

(

)

[inline, virtual]

Public destructor. Objects instancies can be deleted through this interface.

Member Functions Documentation

GetSearchId()

MXIMPIdentity &

GetSearchId

(

)

const [pure virtual]

returns search identity

GetSearchKey()

TSearchKey

GetSearchKey

(

)

const [pure virtual]

returns key value of the search

GetSearchLabel()

MXIMPIdentity &

GetSearchLabel

(

)

const [pure virtual]

returns label identity

SetRequestL(MXIMPIdentity &, TSearchKey)

void	SetRequestL	(	MXIMPIdentity &	aSearchStringId,
			TSearchKey	aKey
		)	[pure virtual]

Set search values. e.g. to serach for "james" as a first name aSearchStringId has to be set with "james" aKey is EUserFirstName

leave: KErrArgument if client trys to set 'EReadLabel' as key. if aKey = EReadLabel then leaves with KErrArgument

Parameters

MXIMPIdentity & aSearchStringId	Identification for search word.
TSearchKey aKey	search key value.

SetRequestL(MXIMPIdentity &, MXIMPIdentity &)

void	SetRequestL	(	MXIMPIdentity &	aSearchStringId,
			MXIMPIdentity &	aLabelId
		)	[pure virtual]

Set search values. e.g. to serach for "james" as a first name aSearchStringId has to be set with "james" aLabelId is "firstname" : this changes from server to server client has to query these labels from server and use

Parameters

MXIMPIdentity & aSearchStringId	Identification for search word.
MXIMPIdentity & aLabelId	Identification for label.