homescreensrv_plat/sapi_contentpublishing/inc/cpclientiterable.h
changeset 73 4bc7b118b3df
parent 66 32469d7d46ff
child 80 397d00875918
child 81 5ef31a21fdd5
equal deleted inserted replaced
66:32469d7d46ff 73:4bc7b118b3df
     1 /*
       
     2 * Copyright (c) 2006-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:  CPS Client iterable
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CPSERVERITERABLE_H
       
    20 #define C_CPSERVERITERABLE_H
       
    21 
       
    22 #include <liwcommon.h>
       
    23 
       
    24 /**
       
    25  * Implemenation of abstract interface to iterate over data items
       
    26  * returned by CPS Server
       
    27  *
       
    28  * @see CLiwIterable
       
    29  *
       
    30  */
       
    31 class CCPClientIterable : public CLiwIterable
       
    32     {
       
    33 public:
       
    34 
       
    35     /**
       
    36      * Two-phase Constructor
       
    37      * @param aList list to be iterated 
       
    38      * @return new CIterableCalList object
       
    39      */
       
    40     static CCPClientIterable* NewL( CLiwGenericParamList* aList );
       
    41 
       
    42     /**
       
    43      * Resets the iterator. 
       
    44      *
       
    45      * @return void
       
    46      */
       
    47     void Reset();
       
    48 
       
    49     /**
       
    50      * Iterates over the collection entries to fetch the next data element.
       
    51      *
       
    52      * @param aValue contains the next data element
       
    53      *
       
    54      * @return false if there are no more data elements to be fetched;
       
    55      * true otherwise
       
    56      */
       
    57     TBool NextL( TLiwVariant& aValue );
       
    58 
       
    59     /**
       
    60      * Destructor.
       
    61      */
       
    62     ~CCPClientIterable();
       
    63 
       
    64 private:
       
    65 
       
    66     /**
       
    67      * C++ default constructor.
       
    68      */     
       
    69     CCPClientIterable( CLiwGenericParamList* aList );
       
    70 
       
    71     /**
       
    72      * Exctracts maps stored inside aMap as binaries and
       
    73      * inserts them as CLiwDefaultMap 
       
    74      *
       
    75      * @param aMap Source and target of the operation
       
    76      */
       
    77     void ExctractBinariesL( CLiwDefaultMap& aMap );
       
    78 
       
    79 private:
       
    80 
       
    81     /**
       
    82      * CLiwGenericParamList  class pointer
       
    83      * Own.
       
    84      */
       
    85     CLiwGenericParamList* iList;
       
    86 
       
    87     /**
       
    88      * Position on iList
       
    89      * Own.
       
    90      */
       
    91     TInt iPos;
       
    92 
       
    93     };
       
    94 
       
    95 #endif // C_CPSERVERITERABLE_H
       
    96 // end of file