emailcontacts/remotecontactlookup/engine/inc/mpbkxremotecontactlookupprotocolenv.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:  Definition of the class MPbkxRemoteContactLookupProtocolEnv
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPBKXREMOTECONTACTLOOKUPPROTOCOLENV_H
       
    20 #define MPBKXREMOTECONTACTLOOKUPPROTOCOLENV_H
       
    21 
       
    22 #include <cntitem.h>
       
    23 #include "cpbkxremotecontactlookupprotocolaccount.h"
       
    24 #include "cpbkxremotecontactlookupprotocolresult.h"
       
    25 
       
    26 /**
       
    27  *  Interface to construct instances of classes needed by the protocol adaptation.
       
    28  *
       
    29  *  @since S60 3.1
       
    30  */
       
    31 class MPbkxRemoteContactLookupProtocolEnv
       
    32     {
       
    33 public:
       
    34 
       
    35     /**
       
    36      * Factory method to create a new protocol account instance. Ownership
       
    37      * is given to the caller.
       
    38      *
       
    39      * @param aId protocol account identifier
       
    40      * @param aName protocol account name
       
    41      *
       
    42      * @return protocol account
       
    43      */
       
    44     virtual CPbkxRemoteContactLookupProtocolAccount* NewProtocolAccountL( 
       
    45         TPbkxRemoteContactLookupProtocolAccountId aId, 
       
    46         const TDesC& aName ) = 0;
       
    47         
       
    48     /**
       
    49      * Factory method to create a new protocol result instance. Ownership is
       
    50      * given to the caller.
       
    51      *
       
    52      * @param aIsComplete is search result complete?
       
    53      * @param aContactItem contact item, owernship is transfered to this object
       
    54      * @param aExtraProtocolData extra protocol data for two-phase search
       
    55      *
       
    56      * @return protocol result
       
    57      */
       
    58     virtual CPbkxRemoteContactLookupProtocolResult* NewProtocolResultL(
       
    59         TBool aIsComplete, 
       
    60         CContactItem& aContactItem, 
       
    61         const TDesC& aExtraProtocolData ) = 0;
       
    62     };
       
    63 
       
    64 #endif // MPBKXREMOTECONTACTLOOKUPPROTOCOLENV_H