searcher/searchserver/inc/csearchserversubsession.h
changeset 0 671dee74050a
child 1 6f2c1c46032b
equal deleted inserted replaced
-1:000000000000 0:671dee74050a
       
     1 /*
       
     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: 
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CSEARCHSERVERSUBSESSION_H_
       
    19 #define CSEARCHSERVERSUBSESSION_H_
       
    20 
       
    21 #include "CCPixAsyncronizer.h"
       
    22 
       
    23 // FORWARD DECLARATIONS
       
    24 class CSearchServerSession;
       
    25 class CCPixIdxDb;
       
    26 class CCPixSearch;
       
    27 class CSearchDocument;
       
    28 
       
    29 class CSearchServerSubSession : public CObject, public MCPixAsyncronizerObserver
       
    30 {
       
    31 public:
       
    32 	static CSearchServerSubSession* NewL(CSearchServerSession* aSession);
       
    33 	static CSearchServerSubSession* NewLC(CSearchServerSession* aSession);
       
    34 	virtual ~CSearchServerSubSession();
       
    35 	
       
    36 public:	
       
    37 	/**
       
    38 	 * OpenDatabaseL.
       
    39 	 * Opens database 
       
    40 	 * @param aMessage Message from client.
       
    41 	 */
       
    42 	void OpenDatabaseL(const RMessage2& aMessage);
       
    43 	
       
    44 	/**
       
    45 	 * SetAnalyzerL.
       
    46 	 * Sets the analyzer to be used with indexing and searchign 
       
    47 	 * @param aMessage Message from client.
       
    48 	 */
       
    49 	void SetAnalyzerL(const RMessage2& aMessage);
       
    50 		
       
    51 	/**
       
    52 	 * SearchL.
       
    53 	 * Issues an OpenC search.
       
    54 	 * @param aMessage Message from client.
       
    55 	 */
       
    56 	void SearchL(const RMessage2& aMessage);
       
    57 	
       
    58 	/**
       
    59 	 * SearchCompleteL.
       
    60 	 * Completes an OpenC search
       
    61 	 */
       
    62 	void SearchCompleteL(const RMessage2& aMessage);
       
    63 
       
    64 	/**
       
    65 	 * GetDocumentL.
       
    66 	 * Client gets the next documents (result) when SearchL has completed
       
    67 	 * @param aMessage Message from client.
       
    68 	 */
       
    69 	void GetDocumentL(const RMessage2& aMessage);
       
    70 	
       
    71 	/**
       
    72 	 * GetDocumentCompleteL.
       
    73 	 * Completes an previous call to GetDocumentL 
       
    74 	 */
       
    75 	void GetDocumentCompleteL(const RMessage2& aMessage);
       
    76 
       
    77 	/**
       
    78 	 * GetDocumentObjectL.
       
    79 	 * Client gets the object after GetDocumentL() has completed 
       
    80 	 * @param aMessage Message from client.
       
    81 	 */
       
    82 	void GetDocumentObjectL(const RMessage2& aMessage);
       
    83 
       
    84 	/**
       
    85 	 * AddL.
       
    86 	 * Adds document to index
       
    87 	 * @param aMessage Message from client.
       
    88 	 */
       
    89 	void AddL(const RMessage2& aMessage);
       
    90 
       
    91 	/*
       
    92 	 * AddCompleteL.
       
    93 	 * Completes an previous call to AddL 
       
    94 	 */
       
    95 	void AddCompleteL(const RMessage2& aMessage);
       
    96 	
       
    97 	/**
       
    98 	 * UpdateL.
       
    99 	 * Updates document to index
       
   100 	 * @param aMessage Message from client.
       
   101 	 */
       
   102 	void UpdateL(const RMessage2& aMessage);
       
   103 	
       
   104 	/*
       
   105 	 * UpdateCompleteL.
       
   106 	 * Completes an previous call to UpdateL 
       
   107 	 */
       
   108 	void UpdateCompleteL(const RMessage2& aMessage);
       
   109 	
       
   110 	
       
   111 	/**
       
   112 	 * DeleteL.
       
   113 	 * Deletes document from index
       
   114 	 * @param aMessage Message from client.
       
   115 	 */
       
   116 	void DeleteL(const RMessage2& aMessage);
       
   117 
       
   118 	/*
       
   119 	 * DeleteCompleteL.
       
   120 	 * Completes an previous call to DeleteL 
       
   121 	 */
       
   122 	void DeleteCompleteL(const RMessage2& aMessage);
       
   123 	
       
   124 	/*
       
   125 	 * FlushCompleteL.
       
   126 	 * Completes an previous call to FlushL 
       
   127 	 */
       
   128 	void FlushCompleteL(const RMessage2& aMessage);
       
   129 	
       
   130 	/**
       
   131 	 * ResetL.
       
   132 	 * Deletes all documents from 
       
   133 	 * @param aMessage Message from client.
       
   134 	 */
       
   135 	void ResetL(const RMessage2& aMessage);
       
   136 	
       
   137 	/**
       
   138 	 * FlushL.
       
   139 	 * Issues CPix flush
       
   140 	 * @param aMessage Message from client.
       
   141 	 */
       
   142 	void FlushL(const RMessage2& aMessage);
       
   143 
       
   144 	/**
       
   145 	 * CancelAll.
       
   146 	 * Client calls this to cancel any asyncronous call.
       
   147 	 */
       
   148 	void CancelAll(const RMessage2& aMessage);
       
   149 	
       
   150 protected:
       
   151 	void HandleAsyncronizerComplete(TCPixTaskType aType, TInt aError, const RMessage2& aMessage);
       
   152 	
       
   153 private:
       
   154 	void ConstructL();
       
   155 	CSearchServerSubSession(CSearchServerSession* aSession);	
       
   156 		
       
   157 private:
       
   158 	CCPixIdxDb* iIndexDb;
       
   159 	CCPixSearch* iSearchDb;
       
   160 	CSearchDocument* iNextDocument;
       
   161 	CSearchServerSession* iSession;
       
   162 };
       
   163 
       
   164 #endif /* CSEARCHSERVERSUBSESSION_H_ */