1 /*

     2 * Copyright (c) 2007 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:  Interface for Search Feature Protocol

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MPROTOCOLSEARCH_H

    21 #define MPROTOCOLSEARCH_H

    22 

    23 #include <badesca.h>

    24 #include <ximpbase.h>

    25 #include <searchprotocolpluginifids.hrh>

    26 

    27 class MXIMPIdentity;

    28 class MSearchElement;

    29 /**

    30  * Interface for Search object.

    31  * Interface must be implemented by a XIMP Framework protocol

    32  * plug-ins.

    33  *

    34  * This interface defines actions that XIMP Framework

    35  * requests from a Search protocol connection to

    36  * execute search related tasks.

    37  *

    38  *

    39  * @ingroup ProtocolSearchpluginapi

    40  * 

    41  */

    42 class MProtocolSearch : public MXIMPBase

    43     {

    44 public:

    45 

    46     /** Interface ID for the MProtocolSearch */

    47     enum { KInterfaceId = SEARCH_IF_ID_PROTOCOL_SEARCH };

    48 

    49 

    50 protected:

    51 

    52     /**

    53      * Protected destructor. MProtocolSearch

    54      * instancies can't be destroyed via this interface.

    55      */

    56     virtual inline ~MProtocolSearch() {};

    57 

    58 

    59 public: 

    60 

    61     /**

    62      * Requests the protocol to start search.

    63      *

    64      *

    65      * @param [in] aSearchId

    66      *		Identification for a search.

    67      *

    68      * @param [in] aObjs

    69      *        Defines what is to be searched. 

    70      *

    71      * @param [in] aSearchLimit

    72      *        How many results client wants at a time. 

    73      *

    74      * @param [in] aReqId

    75      * 		  request ID identifying the issued request.

    76      */

    77     virtual void DoSearchL( const  MXIMPIdentity& aSearchId,

    78 							const  RPointerArray< MSearchElement >& aObjs,

    79 							TInt   aSearchLimit,

    80 	                		TXIMPRequestId aReqId ) = 0;

    81 

    82     

    83 

    84     /**

    85      * Requests the protocol to  Stop search.

    86      *

    87      * @param [in] aSearchId

    88      *		Identification for a search.

    89      *

    90      *

    91      * @param [in] aReqId

    92      * 		  request ID identifying the issued request

    93      */

    94 /*	virtual void DoCancelSearchL( const MXIMPIdentity& aSearchId,

    95                                         TXIMPRequestId aReqId ) = 0;*/

    96 	

    97     /**

    98      * Requests the protocol to get the serach keys

    99      *

   100      *

   101      * @param [in] aReqId

   102      *        request ID identifying the issued request

   103      */

   104     virtual void DoGetSearchKeysL( TXIMPRequestId aReqId ) = 0;

   105 

   106     };

   107 

   108 

   109 

   110 #endif // MPROTOCOLIMSEARCH_H