Collapse all Symbian^3 Product Developer Library

CSearchClientSessionImp Class Reference

class CSearchClientSessionImp : public CActive

This class represents an implementation to the client side session to search framework. This class is dervied from CActive and is used to impliment the session in the \ client side searchclient.lib

Inherits from

CSearchClientSessionImp
- CActive
  - CBase

Public Member Functions
	~CSearchClientSessionImp()
void	CancelResult()
void	CancelSearch()
HBufC8 *	GetLaunchInfoL(const CSearchDocumentId &)
void	GetResultsL(const RPointerArray< CSearchDocumentId > &, MSearchResultRetrieveObserver *)
void	GetSupportedContentL(RPointerArray< CSearchContent > &, TUid)
void	GetSupportedServicesL(RArray< TUid > &)
TBool	IsSearching()
void	LaunchApplicationL(const CSearchDocumentId &)
CSearchClientSessionImp *	NewL()
CSearchClientSessionImp *	NewLC()
void	SearchL(const CSearchQuery &, const TSearchThreshold &, MSearchQueryObserver *)

Private Member Functions
	CSearchClientSessionImp()
void	ConstructL()
void	ContinueSearchingLightL()
void	DoCancel()
TInt	RunError(TInt)
void	RunL()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()

Inherited Enumerations
	CActive:TPriority

Private Attributes
TBool	iGetRes
RPointerArray< CSearchLightResult >	iLightResultArray
TInt	iMaxresults
MSearchQueryObserver *	iObserver
RPointerArray< CSearchDocumentId >	iResultIDArray
MSearchResultRetrieveObserver *	iRetrieveObserver
RSearchClient	iSearchClient
TPckgBuf< TInt >	iSearchCount
TPckgBuf< TInt >	iSearchFinished
TBool	iSearchPending
TPckgBuf< TInt >	iSearchRes
TInt	iSearchTotalResultsFound
RPointerArray< CSearchResult >	iheavyresult

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CSearchClientSessionImp()

CSearchClientSessionImp

(

)

[private]

Performs the first phase of two phase construction.

~CSearchClientSessionImp()

~CSearchClientSessionImp

(

)

[virtual]

Destructor

Member Functions Documentation

CancelResult()

void

CancelResult

(

)

Cancels the currently ongoing search.

CancelSearch()

void

CancelSearch

(

)

Cancels the currently ongoing search.

ConstructL()

void

ConstructL

(

)

[private]

Performs the second phase construction.

ContinueSearchingLightL()

void

ContinueSearchingLightL

(

)

[private]

Continues asking Light results

DoCancel()

void

DoCancel

(

)

[private, virtual]

From CActive. Implements cancellation of an outstanding request.

GetLaunchInfoL(const CSearchDocumentId &)

HBufC8 *

GetLaunchInfoL

(

const CSearchDocumentId &

aDocumentID

)

Get file launch information.

Parameters

const CSearchDocumentId & aDocumentID

GetResultsL(const RPointerArray< CSearchDocumentId > &, MSearchResultRetrieveObserver *)

void	GetResultsL	(	const RPointerArray< CSearchDocumentId > &	aResultIDArray,
			MSearchResultRetrieveObserver *	aObserver
		)

Gets the results. Asynchronous.

Parameters

const RPointerArray< CSearchDocumentId > & aResultIDArray	The array of result ids.
MSearchResultRetrieveObserver * aObserver	Pointer to the observer.

GetSupportedContentL(RPointerArray< CSearchContent > &, TUid)

void	GetSupportedContentL	(	RPointerArray< CSearchContent > &	aContent,
			TUid	aServiceId
		)

Function returning a list of support content types that can be searched by the engine.

Parameters

RPointerArray< CSearchContent > & aContent
TUid aServiceId

GetSupportedServicesL(RArray< TUid > &)

void

GetSupportedServicesL

(

RArray< TUid > &

aServiceIdArray

)

Gets supported service ids by the search framework.

Parameters

RArray< TUid > & aServiceIdArray

IsSearching()

TBool

IsSearching

(

)

Function returning ETrue when a search is ongoing. EFalse otherwise.

LaunchApplicationL(const CSearchDocumentId &)

void

LaunchApplicationL

(

const CSearchDocumentId &

aResultId

)

Launches a viewer/editor application for the given result id.

Parameters

const CSearchDocumentId & aResultId

The id of the given document.

NewL()

CSearchClientSessionImp *

NewL

(

)

[static]

Symbian OS 2 phased constructor.

NewLC()

CSearchClientSessionImp *

NewLC

(

)

[static]

Symbian OS 2 phased constructor.

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[private, virtual]

From CActive. Handles a leave occurring in the request completion event handler RunL().

Parameters

TInt aError

RunL()

void

RunL

(

)

[private, virtual]

From CActive. Handles an active object s request completion event.

SearchL(const CSearchQuery &, const TSearchThreshold &, MSearchQueryObserver *)

void	SearchL	(	const CSearchQuery &	aQuery,
			const TSearchThreshold &	aThreshold,
			MSearchQueryObserver *	aObserver
		)

Starts the search with the specified search criteria.

Parameters

const CSearchQuery & aQuery	Search Query.
const TSearchThreshold & aThreshold
MSearchQueryObserver * aObserver

Member Data Documentation

TBool iGetRes

TBool

iGetRes

[private]

RPointerArray< CSearchLightResult > iLightResultArray

RPointerArray< CSearchLightResult >

iLightResultArray

[private]

Light res Array

TInt iMaxresults

TInt

iMaxresults

[private]

Maxe res

MSearchQueryObserver * iObserver

MSearchQueryObserver *

iObserver

[private]

Pointer to iObserver Not own

RPointerArray< CSearchDocumentId > iResultIDArray

RPointerArray< CSearchDocumentId >

iResultIDArray

[private]

MSearchResultRetrieveObserver * iRetrieveObserver

MSearchResultRetrieveObserver *

iRetrieveObserver

[private]

Pointer to iRetrieveObserver Not own

RSearchClient iSearchClient

RSearchClient

iSearchClient

[private]

Client side of the search server

TPckgBuf< TInt > iSearchCount

TPckgBuf< TInt >

iSearchCount

[private]

Set by the server Count of the results found

TPckgBuf< TInt > iSearchFinished

TPckgBuf< TInt >

iSearchFinished

[private]

Set by the server when no more results Validation

TBool iSearchPending

TBool

iSearchPending

[private]

TPckgBuf< TInt > iSearchRes

TPckgBuf< TInt >

iSearchRes

[private]

Set by the server Count of the results found

TInt iSearchTotalResultsFound

TInt

iSearchTotalResultsFound

[private]

To keep the count of total res found

RPointerArray< CSearchResult > iheavyresult

RPointerArray< CSearchResult >

iheavyresult

[private]

Heavy res Array