1 /*

     2 * Copyright (c) 2008 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:  UI control context implementation.

    15 *

    16 */

    17 

    18 #ifndef __MVIMPSTENGINESEARCHMGREXTENTION_H

    19 #define __MVIMPSTENGINESEARCHMGREXTENTION_H

    20 

    21 #include "tvimpstenums.h"

    22 #include "mvimpstengineextentionfeatures.h"

    23 // CLASS DECLARATION

    24 class MVIMPSTEngineSearchExtentionEventObserver;

    25 

    26 /**

    27  *  Interface for search manager.

    28  *

    29  *  @lib vimpstengine.dll

    30  *  @since 5.0

    31  */

    32 class MVIMPSTEngineSearchMgrExtention: public MVIMPSTEngineExtentionFeatures

    33     {

    34     public:  

    35 		

    36 		/**

    37          * Casts MVIMPSTEngineSearchMgrExtention to this interface.

    38          *

    39          * @precond aExtentionFeature.Type() == TVIMPSTEnums::ESearch

    40          *          Panic(EPanicTypeMismatch)

    41          *          is raised if the precondition does not hold.

    42          * @param aExtentionFeature    Base Class .

    43          * @return Casted inteface for the Search Feature

    44          */

    45         IMPORT_C static MVIMPSTEngineSearchMgrExtention& Cast(

    46                 MVIMPSTEngineExtentionFeatures& aExtentionFeature);

    47 

    48         

    49         /**

    50          * Casts constMVIMPSTEngineSearchMgrExtention to this interface.

    51          *

    52          * @precond aExtentionFeature.Type() == TVIMPSTEnums::ESearch

    53          *          Panic(EPanicTypeMismatch)

    54          *          is raised if the precondition does not hold.

    55          * @param aExtentionFeature    Base Class .

    56          * @return Casted inteface for the Search Feature

    57          */        

    58         IMPORT_C static const MVIMPSTEngineSearchMgrExtention& Cast(

    59                 const MVIMPSTEngineExtentionFeatures& aExtentionFeature);

    60 		

    61 		/**

    62 	    * RegisterSearchObserver registers the observer for search notifications

    63 		* @param: aObserver to be registered.

    64 		*/

    65  		virtual void RegisterObserver(MVIMPSTEngineSearchExtentionEventObserver* aObserver) = 0;

    66 

    67 		/**

    68 	    * UnRegisterSearchObserver registers the observer for search notifications

    69 		* @param: aObserver to be registered.

    70 		*/

    71 		virtual void  UnRegisterObserver(MVIMPSTEngineSearchExtentionEventObserver* aObserver ) = 0;

    72 	

    73         /**

    74 	     * SearchContactsL

    75 	     * search a given string from server

    76 		 * @param aKeyDataArray to be search

    77 		 * @return TInt. error if any

    78 		 */

    79          virtual TInt SearchContactsL( RArray<TVIMPSTSearchKeyData>& aKeyDataArray ) = 0;

    80          

    81          /**

    82 	     * SubscribeForSearchKeysL

    83 	     * subscribe for search keys

    84 	     * @return TInt error if any

    85 		 */

    86          virtual TInt SubscribeForSearchKeysL() = 0 ;         

    87          

    88              

    89 	 public:

    90 

    91 	    /**

    92 	    * Destructor.

    93 	    */

    94 	    virtual ~MVIMPSTEngineSearchMgrExtention() {};

    95         

    96     };

    97     

    98 #endif      //__MVIMPSTENGINESEARCHMGREXTENTION_H

    99 //  End of File