inc/CPEngSearchResult2.h
changeset 0 094583676ce7
equal deleted inserted replaced
-1:000000000000 0:094583676ce7
       
     1 /*
       
     2 * Copyright (c) 2004 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:  Search results.
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __CPENGSEARCHRESULT2_H
       
    19 #define __CPENGSEARCHRESULT2_H
       
    20 
       
    21 
       
    22 //  INCLUDES
       
    23 #include <E32Base.h>
       
    24 #include <bamdesca.h>
       
    25 
       
    26 
       
    27 //FORWARD DECLARATIONS
       
    28 class CPEngSearchResultEntry;
       
    29 
       
    30 
       
    31 
       
    32 /**
       
    33  * Search results.
       
    34  *
       
    35  * @lib PEngManager2.lib
       
    36  * @since 3.0
       
    37  */
       
    38 class CPEngSearchResult2 : public CBase
       
    39     {
       
    40 
       
    41         //-----------------------------------------------------------------------
       
    42     protected: /* Construction */
       
    43 
       
    44         /**
       
    45          * C++ constructor.
       
    46          */
       
    47         CPEngSearchResult2( CPEngSearchResultEntry& aImp );
       
    48 
       
    49 
       
    50         /**
       
    51          * Destructor.
       
    52          */
       
    53         ~CPEngSearchResult2();
       
    54 
       
    55 
       
    56 
       
    57 
       
    58         //-----------------------------------------------------------------------
       
    59     public: /* Search result flags */
       
    60 
       
    61 
       
    62         /**
       
    63          * The number of the current findings, as the
       
    64          * network server has found those.
       
    65          * (Note the difference to returned results count.)
       
    66          *
       
    67          * @since 3.0
       
    68          * @return The number of the current findings.
       
    69          */
       
    70         IMPORT_C TInt CurrentFindingsCount() const;
       
    71 
       
    72 
       
    73         /**
       
    74          * Indicates the particular index from which the
       
    75          * next search can start.
       
    76          *
       
    77          * To continue search further, the client must
       
    78          * provide this or modified value to
       
    79          * CPEngSearchTransaction2::ContinueSearchFromNetwork().
       
    80          * By modifying continuation index, client can affect
       
    81          * from which point the search is continued.
       
    82          *
       
    83          * @since 3.0
       
    84          * @return The default continuation index.
       
    85          */
       
    86         IMPORT_C TInt ContinuationIndex() const;
       
    87 
       
    88 
       
    89         /**
       
    90          * Completion flag.
       
    91          *
       
    92          * Indicates whether the client can continue search or not.
       
    93          * EFalse if server may provide new results (still searching).
       
    94          * ETrue if new results will not be provided.
       
    95          *
       
    96          * @since 3.0
       
    97          * @return Completion flag.
       
    98          */
       
    99         IMPORT_C TBool SearchCompleted() const;
       
   100 
       
   101 
       
   102 
       
   103         //-----------------------------------------------------------------------
       
   104     public: /* Search results */
       
   105 
       
   106 
       
   107         /**
       
   108          * User results.
       
   109          *
       
   110          * @since 3.0
       
   111          * @return User results array.
       
   112          * If there isn't any user results, the array is empty.
       
   113          */
       
   114         IMPORT_C const MDesCArray& UserResults() const;
       
   115 
       
   116 
       
   117 
       
   118 
       
   119 
       
   120         //-----------------------------------------------------------------------
       
   121     private: /* Data */
       
   122 
       
   123 
       
   124         /**
       
   125          * Implementation is friend.
       
   126          * @since 3.0
       
   127          */
       
   128         friend class CPEngSearchResultEntry;	// CSI: 36 #
       
   129 
       
   130         //REF: Implementation
       
   131         CPEngSearchResultEntry&    iImp;
       
   132 
       
   133     };
       
   134 
       
   135 #endif      //__CPENGSEARCHRESULT2_H
       
   136 
       
   137 
       
   138 //End of file
       
   139 
       
   140 
       
   141 
       
   142