searchsrv_plat/cpix_framework_api/inc/ccpixsearcher.h
changeset 14 8bd192d47aaa
parent 8 6547bf8ca13a
equal deleted inserted replaced
13:fcb2a58c181b 14:8bd192d47aaa
   233 	     * KErrNotReady, if no database has been succefullly opened.
   233 	     * KErrNotReady, if no database has been succefullly opened.
   234 	     *
   234 	     *
   235          * @return Next available document or NULL, if no more documents can be found
   235          * @return Next available document or NULL, if no more documents can be found
   236 		 */
   236 		 */
   237 		IMPORT_C void GetDocumentL(TInt aIndex, MCPixNextDocumentRequestObserver& aObserver);
   237 		IMPORT_C void GetDocumentL(TInt aIndex, MCPixNextDocumentRequestObserver& aObserver);
       
   238 		
       
   239 		/**
       
   240 	     * GetBatchDocumentL
       
   241 	     * Iterates throught the search result's document list (hits), that is stored in the 
       
   242 	     * server side. The accessed list is ranked and the best matching document is heading 
       
   243 	     * the result list. First call of this method, return best matching, then second best 
       
   244 	     * matching and so forth until all documents have been found. Method returns NULL, 
       
   245 	     * when no more documents can be found.
       
   246 	     *
       
   247 	     * Leaves with KErrInUse, if asynchronous request is pending and 
       
   248 	     * KErrNotReady, if no database has been succefullly opened.
       
   249          *
       
   250          * @todo Having also GetDocumentLC would be nice
       
   251          * @return Next available document or NULL, if no more documents can be found. Ownership is transferred
       
   252 	     */
       
   253 		IMPORT_C CSearchDocument** GetBatchDocumentL(TInt aIndex, TInt& aReturnDoc, TInt aCount = 1);
       
   254 		
       
   255 		/**
       
   256 	     * GetBatchDocumentL
       
   257 		 * Iterates throught the search result's document list (hits), that is stored in the 
       
   258 	     * server side. The accessed list is ranked and the best matching document isheading 
       
   259 	     * the result lest. When the request has been completed a callback to 
       
   260 	     * MSearchObserver::HandleDocumentL is issued. 
       
   261 	     *
       
   262 	     * Leaves with KErrInUse, if asynchronous request is pending and 
       
   263 	     * KErrNotReady, if no database has been succefullly opened.
       
   264 	     *
       
   265          * @return Next available document or NULL, if no more documents can be found
       
   266 		 */
       
   267 		IMPORT_C void GetBatchDocumentL(TInt aIndex, MCPixNextDocumentRequestObserver& aObserver, TInt aCount = 1);
   238 				
   268 				
   239 	protected: // Functions from base classes
   269 	protected: // Functions from base classes
   240 	
   270 	
   241 	    /**
   271 	    /**
   242 	    * From CActive, RunL.
   272 	    * From CActive, RunL.
   285 			{ 
   315 			{ 
   286 			EStateNone = 0,
   316 			EStateNone = 0,
   287 			EStateOpenDatabase, 
   317 			EStateOpenDatabase, 
   288 			EStateSearch, 
   318 			EStateSearch, 
   289 			EStateGetDocument,
   319 			EStateGetDocument,
       
   320 			EStateGetBatchDocument,
   290 			EStateSetAnalyzer,
   321 			EStateSetAnalyzer,
   291 			EStateSetQueryParser
   322 			EStateSetQueryParser
   292 			};
   323 			};
   293 		
   324 		
   294 		union TObserver 
   325 		union TObserver