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 CPbkxRemoteContactLookupProtocolResult.

    15 *

    16 */

    17 

    18 

    19 #ifndef CPBKXREMOTECONTACTLOOKUPPROTOCOLRESULT_H

    20 #define CPBKXREMOTECONTACTLOOKUPPROTOCOLRESULT_H

    21 

    22 #include <cntitem.h>

    23 

    24 /**

    25  *  Results are returned through this interface. Results ownership is always 

    26  *  transfered to the client so it must take care of deleting them. 

    27  *

    28  *  @since S60 3.1

    29  */

    30 class CPbkxRemoteContactLookupProtocolResult : public CBase

    31     {

    32 

    33 public:

    34 

    35     /**

    36      * Is the search result complete or do we need a second phase?

    37      * 

    38      * @return ETrue if the search result is complete.

    39      */

    40     virtual TBool IsComplete() const = 0; 

    41     

    42     /**

    43     * Sets result as complete.

    44     *

    45     * This means that result now contains all possible fields and no more

    46     * fields can be retrieved.

    47     */

    48     virtual void Complete() = 0;

    49 

    50     /**

    51      * Returns extra protocol data need for mapping contact item to protocol 

    52      * level entries.

    53      *

    54      * @return extra protocol data

    55      */

    56     virtual const TDesC& ExtraProtocolData() const = 0;        

    57 

    58     /** 

    59      * Returns contact item.

    60      *

    61      * @return contact item

    62      */

    63     virtual CContactItem& ContactItem() = 0;         

    64     };

    65 

    66 

    67 #endif // CPBKXREMOTECONTACTLOOKUPPROTOCOLRESULT_H