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:  Definition of the class CPbkxRemoteContactLookupProtocolSession.

    15 *

    16 */

    17 

    18 

    19 #ifndef CPBKXREMOTECONTACTLOOKUPPROTOCOLSESSION_H

    20 #define CPBKXREMOTECONTACTLOOKUPPROTOCOLSESSION_H

    21 

    22 #include "cpbkxremotecontactlookupprotocolresult.h"

    23 #include "mpbkxremotecontactlookupprotocolsessionobserver.h"

    24 #include "tpbkxremotecontactlookupprotocolaccountid.h"

    25 

    26 /**

    27  *  Protocol session.

    28  *

    29  *  @since S60 3.1

    30  */

    31 class CPbkxRemoteContactLookupProtocolSession : public CBase

    32     {

    33 

    34 public:

    35 

    36     /**

    37      * Initialize session search session.

    38      *

    39      * @param aObserver observer for the session

    40      * @param aAccountId remote account that is searched

    41      */

    42     virtual void InitializeL( 

    43         MPbkxRemoteContactLookupProtocolSessionObserver& aObserver,

    44         const TPbkxRemoteContactLookupProtocolAccountId& aAccountId ) = 0;

    45         

    46 

    47     /**

    48      * Start loose search with given query.     

    49      *

    50      * @param aQueryText query text

    51      * @param aMaxMatches maximum number of matches

    52      */

    53     virtual void LooseSearchL( const TDesC& aQueryText, TInt aMaxMatches ) = 0;

    54      

    55     /**

    56      * Retrieves rest of the contact fields. Contact items in the results

    57      * array are reused and new fields are just added to them.

    58      *

    59      * @param aResults set of results for which the 

    60      */

    61     virtual void RetrieveContactFieldsL( 

    62         RPointerArray<CPbkxRemoteContactLookupProtocolResult>& aResults ) = 0;

    63         

    64     /**

    65      * Cancels either the search or detail retrieval process.

    66      */

    67     virtual void Cancel() = 0;            

    68     };

    69 

    70 #endif // CPBKXREMOTECONTACTLOOKUPPROTOCOLSESSION_H