FCL/sf/app/contacts: comparison contacts_plat/predictivesearch_client

equal deleted inserted replaced

-:4ae315f230bc
+:a6539d1e8e43
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
-* Description:  This is the client side interface declaration for the
+* Description: This is the client side interface declaration for the
-*                predictive search server.
+*              predictive search server.
 *
 */
 #ifndef __CPSREQUESTHANDLER_H__
 * @since S60 v3.2
 */
 class CPSRequestHandler : public CActive
 {
-	public: // Constructors and destructors
+public: // Constructors and destructors
-		/**
+/**
-		* NewL.
+* NewL.
-		* Two-phased constructor.
+* Two-phased constructor.
-		* Creates a CPSRequestHandler object using two phase construction,
+* Creates a CPSRequestHandler object using two phase construction,
-		* and return a pointer to the created object.
+* and return a pointer to the created object.
-		*
+*
-		* @return A pointer to the created instance of CPSRequestHandler.
+* @return A pointer to the created instance of CPSRequestHandler.
-		*/
+*/
-		IMPORT_C static CPSRequestHandler* NewL();
+IMPORT_C static CPSRequestHandler* NewL();
-		/**
+/**
-		* NewLC.
+* NewLC.
-		* Two-phased constructor.
+* Two-phased constructor.
-		* Creates a CPSRequestHandler object using two phase construction,
+* Creates a CPSRequestHandler object using two phase construction,
-		* and return a pointer to the created object.
+* and return a pointer to the created object.
-		*
+*
-		* @return A pointer to the created instance of CPSRequestHandler.
+* @return A pointer to the created instance of CPSRequestHandler.
-		*/
+*/
-		IMPORT_C static CPSRequestHandler* NewLC();
+IMPORT_C static CPSRequestHandler* NewLC();
-		/**
+/**
-		* ~CPSRequestHandler.
+* ~CPSRequestHandler.
-		* Destructor.
+* Destructor.
-		* Destroys the object and release all memory objects.
+* Destroys the object and release all memory objects.
-		*/
+*/
-		virtual ~CPSRequestHandler();
+virtual ~CPSRequestHandler();
-	public: // New functions
+public: // New functions
-		/**
+/**
-		* Version.
+* Version.
-		* Returns the predictive search server version.
+* Returns the predictive search server version.
-		*
+*
-		* @return The current version of predictive search server.
+* @return The current version of predictive search server.
-		*/
+*/
-		IMPORT_C TVersion Version() const;
+IMPORT_C TVersion Version() const;
-		/**
+/**
-		* AddObserver.
+* AddObserver.
-		*
+*
-		* @param aObserver The object to be used to handle updates
+* @param aObserver The object to be used to handle updates
-		* from the server.
+* from the server.
-		*/
+*/
-		IMPORT_C void AddObserverL ( MPsResultsObserver* aObserver );
+IMPORT_C void AddObserverL( MPsResultsObserver* aObserver );
-		/**
+/**
-		* RemoveObserverL.
+* RemoveObserverL.
-		*
+*
-		* @param aObserver The object used to handle updates from the server.
+* @param aObserver The object used to handle updates from the server.
-		* @return KErrNone if removed.
+* @return KErrNone if removed.
-		*         KErrNotFound if observer not added already.
+*         KErrNotFound if observer not added already.
-		*/
+*/
-		IMPORT_C TInt RemoveObserver ( MPsResultsObserver* aObserver );
+IMPORT_C TInt RemoveObserver( MPsResultsObserver* aObserver );
-		/**
+/**
-		* SetSearchSettingsL.
+* SetSearchSettingsL.
-		* Set the databases and fields to be included in search.
+* Set the databases and fields to be included in search.
-		* Databases ids are mapped to virtual phone book URLs.
+* Databases ids are mapped to virtual phone book URLs.
-		* Fields to be searched are mapped to virutal phonebook identifiers.
+* Fields to be searched are mapped to virutal phonebook identifiers.
-		*
+*
-		* @param aSettings Holds the search settings.
+* @param aSettings Holds the search settings.
-		*/
+*/
-		IMPORT_C void SetSearchSettingsL(const CPsSettings& aSettings);
+IMPORT_C void SetSearchSettingsL( const CPsSettings& aSettings );
-		/**
+/**
-		* GetAllContentsL.
+* GetAllContentsL.
-		* Sends a request to the predictive search server to get all cached contents.
+* Sends a request to the predictive search server to get all cached contents.
-		* This is a asynchronous request.
+* This is a asynchronous request.
-		*/
+*/
-		IMPORT_C void GetAllContentsL();
+IMPORT_C void GetAllContentsL();
-		/**
+/**
-		* SearchL.
+* SearchL.
-		* Sends a request to the predictive search server.
+* Sends a request to the predictive search server.
-		* This is a asynchronous request.
+* This is a asynchronous request.
-		*
+*
-		* @param aSearchQuery The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
+* @param aSearchQuery The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
-		* @param aStatus      Holds the completion status of search request.
+* @param aStatus      Holds the completion status of search request.
-		*/
+*/
-		IMPORT_C void SearchL(const CPsQuery& aSearchQuery);
+IMPORT_C void SearchL( const CPsQuery& aSearchQuery );
-		/**
+/**
-		* SearchL.
+* SearchL.
-		* Sends a request to the predictive search server.
+* Sends a request to the predictive search server.
-		* This is a asynchronous request. It considers bookmarked contacts
+* This is a asynchronous request. It considers bookmarked contacts
-		* while sending the results back to the client
+* while sending the results back to the client
-		*
+*
-		* @param aSearchQuery 		The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
+* @param aSearchQuery    The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
-		* @param aMarkedContacts    Array of marked contacts
+* @param aMarkedContacts Array of marked contacts
-		* @param aContactManager	Contact manager instance
+* @param aContactManager Contact manager instance
-		*/
+*/
-		IMPORT_C void SearchL(const CPsQuery& aSearchQuery,
+IMPORT_C void SearchL( const CPsQuery& aSearchQuery,
-							  RPointerArray<CPsClientData>& aMarkedContacts,
+RPointerArray<CPsClientData>& aMarkedContacts,
-							  CVPbkContactManager* aContactManager);
+CVPbkContactManager* aContactManager );
 /**
 * CancelSearch.
 * Cancels ongoing search.
 */
-		IMPORT_C void CancelSearch();
+IMPORT_C void CancelSearch();
-		/**
+/**
-		* LookupL.
+* LookupL.
-		* Sends a request to the predictive search server.
+* Sends a request to the predictive search server.
-		* Does a predictive search in aSearchData for aSearchQuery and return
+* Does a predictive search in aSearchData for aSearchQuery and return
-		* the matches.
+* the matches.
-		* This is a synchronous request.
+* This is a synchronous request.
-		*
+*
-		* @param aSearchQuery The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
+* @param aSearchQuery   The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
-		* @param aSearchData  The input data to be searched.
+* @param aSearchData    The input data to be searched.
-		* @param aMatchSet    The list of matches.
+* @param aMatchSet      The list of matches.
-		* @param aMatchLocation The list matched index and length of match
+* @param aMatchLocation The list matched index and length of match
-		*/
+*/
-		IMPORT_C void LookupL(const CPsQuery& aSearchQuery,
+IMPORT_C void LookupL( const CPsQuery& aSearchQuery,
 const TDesC& aSearchData,
 CDesCArray& aMatchSet,
-RArray<TPsMatchLocation>& aMatchLocation);
+RArray<TPsMatchLocation>& aMatchLocation );
 /**
 * LookupMatchL.
 * Sends a request to the predictive search server.
 * Does a predictive search in aSearchData for aSearchQuery and return
 * the match string in aMatch.
 * If there is no full match aMatch will be empty (Length()==0)
 * This is a synchronous request.
 *
 * @param aSearchQuery The input search query.(Length of aSearchQuery <= KPsQueryMaxLen)
 * @param aSearchData  The input data to be searched.
 * @param aMatch       The matched result
 */
-IMPORT_C void LookupMatchL(const CPsQuery& aSearchQuery,
+IMPORT_C void LookupMatchL( const CPsQuery& aSearchQuery,
 const TDesC& aSearchData,
-TDes& aMatch);
+TDes& aMatch );
-		/**
+/**
-		* IsLanguageSupportedL.
+* IsLanguageSupportedL.
-		* Checks if the language variant is supported by
+* Checks if the language variant is supported by
-		* the predictive search engine.
+* the predictive search engine.
-		* This is a synchronous request.
+* This is a synchronous request.
-		*
+*
-		* @param aLanguage The language which has to be checked
+* @param aLanguage The language which has to be checked
-		* @return ETrue if the language specified is supported by PS engine
+* @return ETrue if the language specified is supported by PS engine
-		*         EFalse otherwise
+*         EFalse otherwise
-		*
+*
-		*/
+*/
-		IMPORT_C TBool IsLanguageSupportedL(const TLanguage aLanguage);
+IMPORT_C TBool IsLanguageSupportedL( const TLanguage aLanguage );
-		/**
+/**
-		* GetCachingStatusL
+* GetCachingStatusL
-		* Gets the status of the caching synchronously
+* Gets the status of the caching synchronously
-		*
+*
-		* @param aResultsBuffer Pointer to the result buffer.
+* @param aResultsBuffer Pointer to the result buffer.
-		*/
+*/
-		IMPORT_C TInt GetCachingStatusL(TCachingStatus& aStatus);
+IMPORT_C TInt GetCachingStatusL( TCachingStatus& aStatus );
-		/**
+/**
-		* ConvertToVpbkLinkLC.
+* ConvertToVpbkLinkLC.
-		* Extract the VPBK contact link associated with the search result.
+* Extract the VPBK contact link associated with the search result.
-		* This is a synchronous request.
+* This is a synchronous request.
-		*
+*
-		* @param aSearchResult PS result for which contact link is required.
+* @param aSearchResult PS result for which contact link is required.
-		* @param aContactManager An instance of contact manager used for link extraction.
+* @param aContactManager An instance of contact manager used for link extraction.
-		* @return The contact link.
+* @return The contact link.
-		*/
+*/
-		IMPORT_C MVPbkContactLink* ConvertToVpbkLinkLC( const CPsClientData& aSearchResult,
+IMPORT_C MVPbkContactLink* ConvertToVpbkLinkLC( const CPsClientData& aSearchResult,
-		                                                CVPbkContactManager& aContactManager );
+CVPbkContactManager& aContactManager );
 /**
 * GetDataOrderL.
 * This function returns the list of supported data fields (mapped to VPbk identifiers)
 * supported by a datastore.
 * This is a synchronous request.
 *
 * @param aDataStore The data store URI.
 * @param aDataOrder This array has the field identifiers returned from the server.
 */
-IMPORT_C void GetDataOrderL(const TDesC& aDataStore, RArray<TInt>& aDataOrder);
+IMPORT_C void GetDataOrderL( const TDesC& aDataStore, RArray<TInt>& aDataOrder );
 /**
 * GetSortOrderL.
 * This function returns the sort order of data fields (mapped to VPbk identifiers)
 * set on a datastore.
 * This is a synchronous request.
 *
 * @param aDataStore The data store URI.
 * @param aSortOrder This array has the field identifiers returned from the server.
 */
-IMPORT_C void GetSortOrderL(const TDesC& aDataStore, RArray<TInt>& aSortOrder);
+IMPORT_C void GetSortOrderL( const TDesC& aDataStore, RArray<TInt>& aSortOrder );
 /**
 * ChangeSortOrderL.
 * This function sets the sort order of data fields (mapped to VPbk identifiers)
 * on a datastore.
 * This is a synchronous request.
 *
 * @param aDataStore The data store URI.
 * @param aSortOrder This array has the field identifiers to be set for this store.
 */
-IMPORT_C void ChangeSortOrderL(const TDesC& aDataStore, RArray<TInt>& aSortOrder);
+IMPORT_C void ChangeSortOrderL( const TDesC& aDataStore, RArray<TInt>& aSortOrder );
 /**
-		* ShutdownServerL
+* GetAdaptiveGridCharactersL.
-		* Shuts down the predictive search engine.
+* This is a support method for Adaptive Search functionality.
-		*
+* As Predictive Search Engine is well suited for keeping an maintaining data
-		* CAUTION: Shutdown of predictive search server shouldn't be done for each
+* structures related to contacts and updated according to contacts
-		* session. It should be done only when the search engine needs to be
+* additions/modifications/deletions, like it is done already in Predictive Search
-		* completely shutdown.
+* Engine.
-		*/
+*
-		IMPORT_C void ShutdownServerL();
+* @param aDataStores   The data store URIs.
+* @param aSearchText   The text in the find box.
-	protected: // Functions from base classes
+* @param aCompanyName  The info if Company Name is required.
+* @param aAdaptiveGrid The returned Adaptive Grid.
-		/**
+*/
-		* From CActive, RunL.
+IMPORT_C void GetAdaptiveGridCharactersL( const MDesCArray& aDataStores,
-		* Callback function.
+const TDesC& aSearchText,
-		* Invoked to handle responses from the server.
+const TBool aCompanyName,
-		*/
+TDes& aAdaptiveGrid );
-		void RunL();
+/**
-		/**
+* ShutdownServerL
-		* From CActive, DoCancel.
+* Shuts down the predictive search engine.
-		* Cancels any outstanding operation.
+*
-		*/
+* CAUTION: Shutdown of predictive search server shouldn't be done for each
-		void DoCancel();
+* session. It should be done only when the search engine needs to be
+* completely shutdown.
-	public:
+*/
+IMPORT_C void ShutdownServerL();
-		/**
-		* Notify observers about the cahcing status
+protected: // Functions from base classes
-		*/
-		void NotifyCachingStatus( TCachingStatus aStatus, TInt aError );
+/**
+* From CActive, RunL.
-	private: // Constructors and destructors
+* Callback function.
+* Invoked to handle responses from the server.
-		/**
+*/
-		* CPSRequestHandler.
+void RunL();
-		* Performs the first phase of two phase construction.
-		*/
+/**
-		CPSRequestHandler();
+* From CActive, DoCancel.
+* Cancels any outstanding operation.
-		/**
+*/
-		* ConstructL.
+void DoCancel();
-		* Performs the second phase construction of a
-		* CPSRequestHandler object.
+public:
-		*/
-		void ConstructL();
+/**
+* Notify observers about the cahcing status
-	private: // Internal data handlers
+*/
+void NotifyCachingStatus( TCachingStatus aStatus, TInt aError );
-		/**
-		* ParseResultsL.
+private: // Constructors and destructors
-		* Parses the results buffer and converts them to data elements.
-		*/
+/**
-		void HandleSearchResultsL();
+* CPSRequestHandler.
+* Performs the first phase of two phase construction.
-		/**
+*/
-		* HandleBufferOverFlowL.
+CPSRequestHandler();
-		* Handles internal buffer overflow event.
-		*/
+/**
-		void HandleBufferOverFlowL();
+* ConstructL.
+* Performs the second phase construction of a
-		/**
+* CPSRequestHandler object.
-		* HandleErrorL.
+*/
-		* Handles error events.
+void ConstructL();
-		*/
-		void HandleErrorL(TInt aErrorCode);
+private: // Internal data handlers
-		/**
+/**
-		* AddMarkedContacts
+* ParseResultsL.
-		* Filters the bookmark results and adds them to final search result set
+* Parses the results buffer and converts them to data elements.
-		*/
+*/
-		TInt AddMarkedContactsL(RPointerArray<CPsClientData>& searchResults);
+void HandleSearchResultsL();
-		/**
+/**
+* HandleBufferOverFlowL.
+* Handles internal buffer overflow event.
+*/
+void HandleBufferOverFlowL();
+/**
+* HandleErrorL.
+* Handles error events.
+*/
+void HandleErrorL(TInt aErrorCode);
+/**
+* AddMarkedContacts
+* Filters the bookmark results and adds them to final search result set
+*/
+TInt AddMarkedContactsL(RPointerArray<CPsClientData>& searchResults);
+/**
 * RunSearchFromBufferL
 * Runs search if search query buffer ( iPendingSearchQueryBuffer ) is not empty
 */
 void RunSearchFromBufferL();
-	private: // Data
+private: // Data
-		/**
+/**
-		* iSession, the predictive search server session.
+* iSession, the predictive search server session.
-		*/
+*/
-		RPsSession iSession;
+RPsSession iSession;
-		/**
+/**
-		* iObservers, observers which handles updates from the server.
+* iObservers, observers which handles updates from the server.
-		*/
+*/
-		RPointerArray<MPsResultsObserver> iObservers;
+RPointerArray<MPsResultsObserver> iObservers;
-		/**
+/**
-		* iSearchQueryBuffer, the buffer that holds the search query.
+* iSearchQueryBuffer, the buffer that holds the search query.
-		*/
+*/
-		HBufC8* iSearchQueryBuffer;
+HBufC8* iSearchQueryBuffer;
-		/**
+/**
 * iPendingSearchQueryBuffer, the buffer that holds the pending search query.
 */
 HBufC8* iPendingSearchQueryBuffer;
-		/**
+/**
-		* iSearchDataBuffer, the buffer that holds the search data.
+* iSearchDataBuffer, the buffer that holds the search data.
-		*/
+*/
-		HBufC8* iSearchDataBuffer;
+HBufC8* iSearchDataBuffer;
-		/**
+/**
-		* iSearchResultsBuffer, the buffer that holds the search results.
+* iSearchResultsBuffer, the buffer that holds the search results.
-		*/
+*/
-		HBufC8* iSearchResultsBuffer;
+HBufC8* iSearchResultsBuffer;
-		/**
+/**
-		* iConverter, instance of contact id converter
+* iConverter, instance of contact id converter
-		*/
+*/
-		CVPbkContactIdConverter* iConverter;
+CVPbkContactIdConverter* iConverter;
 /**
 * iPropertyHandler, the handler to property which is asynchronously monitored
 */
 CPsPropertyHandler* iPropertyHandler;
 /**
 * iContactAddedHandler, handler for reacting to contact being added to cache
 */
 CPsUpdateHandler* iContactAddedHandler;
 /**
 * iContactRemovedHandler, handler for reacting to contact being removed from cache
 */
 CPsUpdateHandler* iContactRemovedHandler;
 /**
 * iContactModifiedHandler, handler for reacting to contact being modified in cache
 */
 CPsUpdateHandler* iContactModifiedHandler;
 /**
 * Not Owned
 * iBookMarkContactManager, contact manager reference received from the client
 * To be used only for handling marked contacts.
 */
 CVPbkContactManager* iBookMarkContactManager;
 /**
 * iMarkedContacts, stores the bookmarked contacts if any, sent by the client
 */
 RPointerArray<CPsClientData> iMarkedContacts;
 /**
 * ETrue, if search request was cancelled
 */
 TBool iSearchRequestCancelled;
 };
 #endif //__CPSREQUESTHANDLER_H__

branch	RCL_3
changeset 39	a6539d1e8e43
parent 35	4ae315f230bc
child 64	c1e8ba0c2b16