logsui/EngineInc/MLogsEventGetter.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 event getter.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __MLogsEventGetter_H_
       
    21 #define __MLogsEventGetter_H_
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32std.h>
       
    25 #include <logwrap.h>
       
    26 #include <cntdef.h>
       
    27 #include "LogsEng.hrh"
       
    28 
       
    29 
       
    30 #include "MLogsEventData.h"
       
    31 #include "MLogsEvent.h"
       
    32 
       
    33 
       
    34 // MACROS
       
    35 
       
    36 // DATA TYPES
       
    37 
       
    38 // FUNCTION PROTOTYPES
       
    39 
       
    40 // FORWARD DECLARATIONS
       
    41 
       
    42 // CLASS DECLARATION
       
    43 
       
    44 /**
       
    45  *  Defines abstract interface for Logs event getter
       
    46  */
       
    47 class MLogsEventGetter
       
    48     {
       
    49     public:
       
    50     
       
    51         virtual ~MLogsEventGetter() {};
       
    52 
       
    53     public:
       
    54     
       
    55        /**
       
    56         *   Event getter
       
    57         *
       
    58         *   @return interface to MLogsEvent
       
    59         */
       
    60         virtual MLogsEvent* Event() const = 0;
       
    61             
       
    62        /**
       
    63         *   Duplicates getter
       
    64         *
       
    65         *   @return number of duplicates
       
    66         */
       
    67         virtual TInt8 Duplicates() const = 0;
       
    68 
       
    69        /**
       
    70         *   Event type getter
       
    71         *
       
    72         *   @return event type
       
    73         */
       
    74         virtual TLogsEventType EventType() const = 0;
       
    75 
       
    76        /**
       
    77         *   Uid getter
       
    78         *
       
    79         *   @return uid
       
    80         */
       
    81         virtual TUid EventUid() const = 0;
       
    82 
       
    83        /**
       
    84         *   Direction getter
       
    85         *
       
    86         *   @return direction
       
    87         */
       
    88         virtual TLogsDirection Direction() const = 0;
       
    89 
       
    90        /**
       
    91         *   Time getter
       
    92         *
       
    93         *   @return time
       
    94         */
       
    95         virtual TTime Time() const = 0;
       
    96 
       
    97        /**
       
    98         *   Log Id getter
       
    99         *
       
   100         *   @return log id
       
   101         */
       
   102         virtual TLogId LogId() const = 0;
       
   103 
       
   104        /**
       
   105         *   Number getter
       
   106         *
       
   107         *   @return number
       
   108         */
       
   109         virtual HBufC* Number() const = 0;
       
   110 
       
   111        /**
       
   112         *   Remote party getter
       
   113         *
       
   114         *   @return remote party
       
   115         */
       
   116         virtual HBufC* RemoteParty() const = 0;
       
   117 
       
   118        /**
       
   119         *   Additional LogsData object.
       
   120         *
       
   121         *   @return  MLogsEventData object.
       
   122         */
       
   123         virtual MLogsEventData* LogsEventData() const = 0;
       
   124 
       
   125        /**
       
   126         *   ALS flag (Alternate line service).
       
   127         *
       
   128         *   @return  ALS status flag. EFalse if not ALS event, ETrue if ALS event.
       
   129         */
       
   130         virtual TBool ALS() const = 0;
       
   131 
       
   132         /**
       
   133         *   CNAP flag (Calling name presentation service).
       
   134         *
       
   135         *   @return  CNAP status flag. EFalse if not CNAP event, ETrue if CNAP event.
       
   136         */
       
   137         virtual TBool CNAP() const = 0;
       
   138 
       
   139 //For ring duation feature
       
   140         /**
       
   141         *   Return Ring Duration
       
   142         *
       
   143         *   @return  Ring Duration
       
   144         */
       
   145         virtual TLogDuration RingDuration() const = 0;
       
   146         
       
   147         /**
       
   148         * Return Phone number field type
       
   149         *
       
   150         * @param Phone number field type
       
   151         */       
       
   152         virtual TInt NumberFieldType() const = 0;
       
   153  
       
   154 
       
   155 
       
   156     };
       
   157 
       
   158             
       
   159 #endif
       
   160 
       
   161 // End of File  __MLogsEventGetter_H_