199 CpixDocument* document(int aIndex) THROWS_EXCEPTION; |
199 CpixDocument* document(int aIndex) THROWS_EXCEPTION; |
200 |
200 |
201 /** |
201 /** |
202 * Asynchronously get the document with index aIndex. |
202 * Asynchronously get the document with index aIndex. |
203 * @param aIndex Index of document to be retrieved |
203 * @param aIndex Index of document to be retrieved |
204 * @return A pointer to CpixDocument that has been retrieved. Null on error. |
|
205 * |
204 * |
206 * @note This should be called only after the synchronous search call has returned |
205 * @note This should be called only after the synchronous search call has returned |
207 * and aIndex should be between 0 and estimated count returned by Search(). |
206 * and aIndex should be between 0 and estimated count returned by Search(). |
208 */ |
207 */ |
209 void documentAsync(int aIndex) THROWS_EXCEPTION; |
208 void documentAsync(int aIndex) THROWS_EXCEPTION; |
|
209 |
|
210 /** |
|
211 * Synchronously get the count,aCount of batch documens with index aIndex. |
|
212 * @param aIndex starting Index of document to be retrieved |
|
213 * @param aCount number of documents requested |
|
214 * @param aReturnDoc number of documents returned |
|
215 * @return A double pointer to CpixDocument that has been retrieved. Null on error. |
|
216 * |
|
217 * @note This should be called only after the synchronous search call has returned |
|
218 * and aIndex should be between 0 and estimated count returned by Search(). |
|
219 * It is the client duty to free the memory allocated for the returned CpixDocument** |
|
220 * deallocation of the memory can be done based on the value returned in aReturnDoc |
|
221 */ |
|
222 CpixDocument** batchdocument(int aIndex,int& aReturnDoc, int aCount = 1) THROWS_EXCEPTION; |
|
223 |
|
224 /** |
|
225 * Asynchronously get the batch documents with index aIndex. |
|
226 * @param aIndex Starting Index of documents to be retrieved |
|
227 * @param aCount number of documents requested |
|
228 * |
|
229 * @note This should be called only after the synchronous search call has returned |
|
230 * and aIndex should be between 0 and estimated count returned by Search(). |
|
231 */ |
|
232 void batchdocumentAsync(int aIndex, int aCount = 1) THROWS_EXCEPTION; |
210 |
233 |
211 /** |
234 /** |
212 * Cancels any outstanding searches. |
235 * Cancels any outstanding searches. |
213 */ |
236 */ |
214 void cancelSearch(); |
237 void cancelSearch(); |
226 * @param aEstimatedResultCount Estimated number of documents found after SearchAsync |
249 * @param aEstimatedResultCount Estimated number of documents found after SearchAsync |
227 */ |
250 */ |
228 void handleSearchResults(int aError, int aEstimatedResultCount); |
251 void handleSearchResults(int aError, int aEstimatedResultCount); |
229 |
252 |
230 /** |
253 /** |
231 * Notify completion of GetDatabaseAsyc |
254 * Notify completion of documentAsyc |
232 * @param aError Completion (error) code of GetDatabaseAsyc |
255 * @param aError Completion (error) code of GetDatabaseAsyc |
233 * @param aDocument The requested document. |
256 * @param aDocument The requested document. |
234 */ |
257 */ |
235 void handleDocument(int aError, CpixDocument* aDocument); |
258 void handleDocument(int aError, CpixDocument* aDocument); |
|
259 |
|
260 /** |
|
261 * Notify completion of BatchdocumentAsyc |
|
262 * @param aError Completion (error) code of GetDatabaseAsyc |
|
263 * @param aDocument The requested document. |
|
264 */ |
|
265 void handleBatchDocuments(int aError,int aRetCount, CpixDocument** aDocument); |
236 |
266 |
237 private: |
267 private: |
238 /** |
268 /** |
239 * Defaul constructor. |
269 * Defaul constructor. |
240 * Creates a CpixSearcher object and return a pointer to the created object. |
270 * Creates a CpixSearcher object and return a pointer to the created object. |