wvuing/wvuieng/EngInc/MCASearchData.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2002 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 for UI
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MCASEARCHDATA_H
       
    20 #define MCASEARCHDATA_H
       
    21 
       
    22 // INCLUDES
       
    23 #include	"MCAImpsFundClient.h"
       
    24 
       
    25 // INCLUDES
       
    26 #include <e32std.h>
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31 *  Search data representation for the UI.
       
    32 *
       
    33 *
       
    34 *  @lib CAEngine.lib
       
    35 *  @since 1.2
       
    36 */
       
    37 class MCASearchData
       
    38     {
       
    39     public:
       
    40 
       
    41         /**
       
    42         * Can we search for more results?
       
    43         * @return ETrue if the search cannot be continued and
       
    44         *         EFalse if the search can be continued.
       
    45         */
       
    46         virtual TBool NoMoreResultsAvailable() const = 0;
       
    47 
       
    48         /**
       
    49         * Returns the type of the search.
       
    50         * @return The type.
       
    51         */
       
    52         virtual TImpsSearchResultType SearchResultType() const = 0;
       
    53 
       
    54         /**
       
    55         * Returns searched data.
       
    56         * @param aIndex specifies the index to the wanted data.
       
    57         * @return This is the search data.
       
    58         */
       
    59         virtual TPtrC SearchData( TInt aIndex ) const = 0;
       
    60 
       
    61         /**
       
    62         * Returns the current search data count
       
    63         * ( I.e. maximum number of available items ).
       
    64         * @return Count of data items.
       
    65         */
       
    66         virtual TInt SearchDataCount() const = 0;
       
    67 
       
    68         /**
       
    69         * The maximum amount of results available in the server.
       
    70         * @return The amount.
       
    71         */
       
    72         virtual TInt HowManyResultsAvailable() const = 0;
       
    73 
       
    74     protected:
       
    75 
       
    76         /**
       
    77         * Destructor.
       
    78         */
       
    79         virtual ~MCASearchData() {};
       
    80     };
       
    81 
       
    82 #endif      // MCASEARCHDATA_H
       
    83 
       
    84 // End of File