MProtocolSearch Class Reference

class MProtocolSearch : public MXIMPBase

Interface for Search object. Interface must be implemented by a XIMP Framework protocol plug-ins.

This interface defines actions that XIMP Framework requests from a Search protocol connection to execute search related tasks.

Inherits from

Public Member Functions
void	DoGetSearchKeysL ( TXIMPRequestId )
void	DoSearchL (const MXIMPIdentity &, const RPointerArray < MSearchElement > &, TInt , TXIMPRequestId )

Protected Member Functions
	~MProtocolSearch ()

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

Inherited Enumerations
	MXIMPBase:@42
	MXIMPBase:TIfGetOps

~MProtocolSearch

(

)

[protected, inline, virtual]

Protected destructor. MProtocolSearch instancies can't be destroyed via this interface.

void

DoGetSearchKeysL

(

aReqId

)

[pure virtual]

Requests the protocol to Stop search.

request ID identifying the issued request

void	DoSearchL	(	const MXIMPIdentity &	aSearchId,
			const RPointerArray < MSearchElement > &	aObjs,
			TInt	aSearchLimit,
			TXIMPRequestId	aReqId
		)	[pure virtual]

Requests the protocol to start search.

const MXIMPIdentity & aSearchId	Identification for a search.
const RPointerArray < MSearchElement > & aObjs	Defines what is to be searched.
TInt aSearchLimit	How many results client wants at a time.
TXIMPRequestId aReqId	request ID identifying the issued request.