logsui/EngineInc/MLogsReader.h
changeset 0 e686773b3f54
equal deleted inserted replaced
-1:000000000000 0:e686773b3f54
       
     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: 
       
    15 *     Defines abstract interface for Logs reader
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __MLogsReader_H_
       
    21 #define __MLogsReader_H_
       
    22 
       
    23 // INCLUDES
       
    24 #include "LogsEng.hrh"
       
    25 #include <CVPbkPhoneNumberMatchStrategy.h>
       
    26 // MACROS
       
    27 
       
    28 // DATA TYPES
       
    29 
       
    30 // FUNCTION PROTOTYPES
       
    31 
       
    32 // FORWARD DECLARATIONS
       
    33 class MLogsObserver;
       
    34 class MLogsReaderConfig;
       
    35 
       
    36 // CLASS DECLARATION
       
    37 
       
    38 /**
       
    39  *  Defines abstract interface for Logs reader and contact updater
       
    40  */
       
    41 class MLogsReader
       
    42     {
       
    43     public:
       
    44     
       
    45         virtual ~MLogsReader() {};
       
    46 
       
    47 
       
    48     public:
       
    49         enum TPreferredPbkStore
       
    50             {
       
    51             EPbkAndSim,
       
    52             EPbkOnly,
       
    53             ESimOnly,
       
    54             // ELdapOnly, 
       
    55             EAllStores
       
    56             };
       
    57 
       
    58     public:
       
    59 
       
    60        /**
       
    61         *   Stop reader
       
    62         */
       
    63         virtual void Stop() = 0;
       
    64 
       
    65        /**
       
    66         *   Interrupt reader
       
    67         */
       
    68         virtual void Interrupt() = 0;
       
    69 
       
    70        /**
       
    71         *   Is reader interrupted
       
    72         *
       
    73         *   @return ETrue if interrupted, otherwise EFalse
       
    74         */
       
    75         virtual TBool IsInterrupted() const = 0;
       
    76 
       
    77        /**
       
    78         *   Observer setter
       
    79         *
       
    80         *   @param  aObserver   pointer to observer
       
    81         */
       
    82         virtual void SetObserver( MLogsObserver* aObserver ) = 0;
       
    83 
       
    84        /**
       
    85         *   Start reader
       
    86         */
       
    87         virtual void StartL() = 0;
       
    88 
       
    89        /**
       
    90         *   Start contact updater
       
    91         */
       
    92         virtual void StartUpdaterL() {};
       
    93 
       
    94        /**
       
    95         *   Continue reading
       
    96         */
       
    97         virtual void ContinueL() = 0;
       
    98 
       
    99 
       
   100        /**
       
   101         *   Configure reader
       
   102         *
       
   103         *   @param  aConfig  pointer to configure info   
       
   104         */
       
   105         virtual void ConfigureL( const MLogsReaderConfig* aConfig ) = 0;
       
   106 
       
   107        /**
       
   108         *   Reader dirty flag getter
       
   109         *
       
   110         *   @return  ETrue if dirty, otherwise EFalse   
       
   111         */
       
   112         virtual TBool IsDirty() const = 0;
       
   113 
       
   114         
       
   115        /**
       
   116         *   Set the Dirty flag to ETrue  
       
   117         */
       
   118         virtual void SetDirty() = 0;
       
   119         
       
   120        /**
       
   121         *   Set reader activated 
       
   122         */
       
   123         virtual void ActivateL() = 0;
       
   124         
       
   125        /**
       
   126         *   Set reader deactivated 
       
   127         */
       
   128         //virtual void DeActivate( TBool aSkipClearDuplicates ) = 0;
       
   129         virtual void DeActivate() = 0;
       
   130 
       
   131        /**
       
   132         *   Clear duplicates - for use of Missed Calls model only. 
       
   133         */
       
   134         virtual void ClearDuplicatesL() {};
       
   135     };
       
   136 
       
   137             
       
   138 #endif
       
   139 
       
   140 // End of File  __MLogsReader_H_