emailcontacts/remotecontactlookup/engine/inc/mpbkxremotecontactlookupserviceui.h
branchRCL_3
changeset 12 4ce476e64c59
parent 11 0396474f30f5
child 13 8592a65ad3fb
equal deleted inserted replaced
11:0396474f30f5 12:4ce476e64c59
     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:  Remote Contact Lookup Service UI interface definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPBKXREMOTECONTACTLOOKUPSERVICEUI_H
       
    20 #define MPBKXREMOTECONTACTLOOKUPSERVICEUI_H
       
    21 
       
    22 #include <e32std.h>
       
    23 #include <cntitem.h>
       
    24 #include "cpbkxremotecontactlookupserviceuicontext.h"
       
    25 #include "cpbkxremotecontactlookupprotocolaccount.h"
       
    26 #include "tpbkxremotecontactlookupprotocolaccountid.h"
       
    27 
       
    28 /**
       
    29  *  Remote Contact Lookup Service UI API
       
    30  *
       
    31  *  @since S60 3.1
       
    32  */
       
    33 class MPbkxRemoteContactLookupServiceUi
       
    34     {
       
    35 
       
    36 public:
       
    37 
       
    38     /**
       
    39      * Execution context construction parameters.
       
    40      */
       
    41     class TContextParams 
       
    42         {
       
    43         public:
       
    44             /** Protocol account identifier */
       
    45             TPbkxRemoteContactLookupProtocolAccountId iProtocolAccountId;
       
    46             
       
    47             /** Execution mode */
       
    48             CPbkxRemoteContactLookupServiceUiContext::TMode iMode;
       
    49         };
       
    50 
       
    51     /**
       
    52     * Returns default account identifier.
       
    53     *
       
    54     * @return default account identifier
       
    55     */
       
    56     virtual TPbkxRemoteContactLookupProtocolAccountId DefaultAccountIdL() const = 0;
       
    57 
       
    58     /**
       
    59     * Creates new account with given protocol account identifier.
       
    60     *
       
    61     * @param aProtocolAccountId protocol account ID.
       
    62     * @return protocol account
       
    63     */
       
    64     virtual CPbkxRemoteContactLookupProtocolAccount* NewAccountL(
       
    65         const TPbkxRemoteContactLookupProtocolAccountId& aProtocolAccountId ) const = 0;
       
    66 
       
    67     /**
       
    68      * Create new execution context.
       
    69      *
       
    70      * @param aParams construction parameters
       
    71      * @return execution context
       
    72      */     
       
    73     virtual CPbkxRemoteContactLookupServiceUiContext* NewContextL( 
       
    74         TContextParams& aParams ) const = 0;    
       
    75     };
       
    76 
       
    77 #endif // MPBKXREMOTECONTACTLOOKUPSERVICEUI_H