1 /*

     2 * Copyright (c) 2006 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:  Represents the search data PC Interface for UI

    15 *

    16 */

    17 

    18 

    19 #ifndef MCASEARCHDATAPC_H

    20 #define MCASEARCHDATAPC_H

    21 

    22 

    23 // INCLUDES

    24 #include	"MCASearchData.h" //from caengine.dll

    25 

    26 

    27 //PLATFORM INCLUDES

    28 #include <e32std.h>

    29 

    30 

    31 

    32 //INTERFACE DECLARATION

    33 /**

    34 *  Search data representation for the UI.

    35 *

    36 *

    37 *  @lib wvuiprocessng.lib

    38 *  @since 3.2

    39 */

    40 class MCASearchDataPC

    41     {

    42     public:

    43 

    44         /**

    45         * Returns searched data.

    46         * @param aIndex specifies the index to the wanted data.

    47         * @return This is the search data.

    48         */

    49         virtual TPtrC SearchData( TInt aIndex ) const = 0;

    50 

    51         /**

    52         * Returns the current search data count

    53         * ( I.e. maximum number of available items ).

    54         * @return Count of data items.

    55         */

    56         virtual TInt SearchDataCount() const = 0;

    57 

    58         /**

    59         * The maximum amount of results available in the server.

    60         * @return The amount.

    61         */

    62         virtual TInt HowManyResultsAvailable() const = 0;

    63 

    64         /**

    65          * Identification of contact. This is resolved from known

    66          * identifications.

    67          * Alias, nickname and contactId.

    68          * Nickname is shown if set.

    69          * @param aContactId Id of contact which identification needed.

    70          * @return Identification of contact.

    71          *      Alias if nickname is not set and alias is enabled.

    72          *      Wvid without domain and prefix if nickname does not

    73                 exists and alias is not enabled or not exists.

    74          */

    75         virtual const TPtrC IdentificationL( const TDesC& aContactId ) = 0;

    76 

    77     protected:

    78 

    79         /**

    80         * Destructor.

    81         */

    82         virtual ~MCASearchDataPC() {};

    83     };

    84 

    85 #endif      // MCASEARCHDATAPC_H

    86 

    87 // End of File