sapi_logging/tsrc/dev/tloggingprovidertest/inc/liwlogiter.h
changeset 0 14df0fbfcc4e
equal deleted inserted replaced
-1:000000000000 0:14df0fbfcc4e
       
     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 the License "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:   Declars  logging Iterator 
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef LIWLOGITER_H
       
    20 #define LIWLOGITER_H
       
    21 
       
    22 /**
       
    23 * LIT Declarations for direction and Status
       
    24 */
       
    25 
       
    26 _LIT(KIncomingEvent , "Incoming") ;
       
    27 _LIT(KOutgoingEvent , "Outgoing") ;
       
    28 _LIT(KIncomingEventAlternateline , "Incoming on alternate line") ;
       
    29 _LIT(KOutgoingEventAlternateline  , "Outgoing on alternate line") ;
       
    30 _LIT(KFetchedEvent , "Fetched") ;
       
    31 _LIT(KMissedEvent , "Missed call") ;
       
    32 _LIT(KMissedEventAlternateline , "Missed call on alternate line") ;
       
    33 _LIT(KStatusPending , "Pending") ;
       
    34 _LIT(KStatusSent , "Sent") ;
       
    35 _LIT(KStatusFalied , "Failed") ;
       
    36 _LIT(KStatusNone , "No delivery") ;
       
    37 _LIT(KStatusDone , "Delivered") ;
       
    38 _LIT(KStatusNotSent , "Not sent") ;
       
    39 _LIT(KStatusScheduled , "Scheduled") ;
       
    40 
       
    41 /**
       
    42 * Forward declarations
       
    43 */
       
    44 class CLiwIterable ;
       
    45 class CLogIter ;
       
    46 
       
    47 class CLiwLogIter : public CLiwIterable
       
    48     {
       
    49     public:
       
    50 
       
    51         /**
       
    52         * Resets the iterator. The service provider should provide a concrete
       
    53         * implementation to reset the iterator.
       
    54         *
       
    55         */
       
    56         IMPORT_C void Reset() ;
       
    57 
       
    58         /**
       
    59         * Iterates over the collection entries to fetch the next data element.
       
    60         * The service provider should provide a concrete implementation
       
    61         * for this method.
       
    62         *
       
    63         * @param aEntry contains the next data element and its corresponding data type
       
    64         *
       
    65         * @return false if there are no more data elements to be fetched;
       
    66         * true otherwise
       
    67         */ 
       
    68         IMPORT_C TBool NextL( TLiwVariant& aEntry ) ;
       
    69 
       
    70         /**
       
    71         * Default equality operator implementation
       
    72         * 
       
    73         * @param aIterable the iterator instance to be compared
       
    74         * 
       
    75         */
       
    76         IMPORT_C  TBool operator==( CLiwIterable& aIterable );
       
    77 
       
    78         /**
       
    79         * Two phase constructors 
       
    80         */
       
    81         static  CLiwLogIter * NewL( CLogIter *aIter ) ;
       
    82         
       
    83         /**
       
    84         * NewLC: Creates an instance of CLiwLogIterClass
       
    85         * Two Phased constructor
       
    86         * returns newly allocated object.
       
    87         */
       
    88         static  CLiwLogIter * NewLC( CLogIter *aIter );
       
    89         
       
    90         /**
       
    91         * SetCLogIter 
       
    92         */
       
    93         inline void  SetCLogIter( CLogIter *aIter )
       
    94             {
       
    95             iLogIter = aIter  ;
       
    96             }
       
    97 
       
    98     protected :
       
    99 
       
   100         /**
       
   101         * ConstructL function to construct the members of the class
       
   102         */
       
   103         void ConstructL( CLogIter *aIter ) ;
       
   104 
       
   105         /**
       
   106         * Default Constructor
       
   107         */
       
   108         CLiwLogIter() ;
       
   109 
       
   110         /**
       
   111         * Default destructor
       
   112         */
       
   113         ~CLiwLogIter() ; 
       
   114 
       
   115     private :
       
   116     
       
   117         /**
       
   118         * private member
       
   119         */
       
   120         CLogIter *iLogIter  ;
       
   121 
       
   122     }  ;
       
   123 
       
   124 #endif