1 /*

     2 * Copyright (c) 2009-2010 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:  Voice mailbox engine implementation

    15 *  Interface   : Private, CVmbxCsVoiceEngine

    16 *

    17 */

    18 

    19 #ifndef C_VMBXCSVOICEENGINE_H

    20 #define C_VMBXCSVOICEENGINE_H

    21 

    22 // INCLUDES

    23 #include "mvmbxresourceprovider.h"

    24 

    25 // FORWARD DECLARATIONS

    26 class CVmbxEngineBase;

    27 class CVmbxSimHandler;

    28 

    29 

    30 // CLASS DECLARATION

    31 /**

    32 *  Implements functionality specifig to voice mailbox entry

    33 *

    34 *  @lib vmbxengine.lib

    35 */

    36 NONSHARABLE_CLASS( CVmbxCsVoiceEngine ) : public CVmbxEngineBase

    37     {

    38 

    39 public:  // Constructors and destructor

    40 

    41     /**

    42      * Two-phased constructor

    43      * @param aProvider Reference to MVmbxResourceProvider.

    44      * @return New instance of the object. Ownership transferred.

    45      */

    46     static CVmbxCsVoiceEngine* NewL( MVmbxResourceProvider& aProvider );

    47 

    48     /**

    49      * Destructor.

    50      */

    51     virtual ~CVmbxCsVoiceEngine();

    52 

    53 // from base class CVmbxEntryBase

    54 

    55     /**

    56      * @see CVmbxEntryBase::GetL

    57      *

    58      * @param aEntry Reference to CVoiceMailboxEntry

    59      */

    60     void GetL( CVoiceMailboxEntry*& aEntry );

    61 

    62     /**

    63      * @see CVmbxEntryBase::SaveL

    64      *

    65      * @param aEntry 

    66      * @param aShowNotesAllowed Provision mode is used to decide whether show

    67      *          saved notification UI dialog. If aShowNotesAllowed is EFalse,

    68      *          saved notification UI dialog will not show. 

    69      */

    70     void SaveL( const CVoiceMailboxEntry& aEntry, 

    71                 TBool aShowNotesAllowed );

    72 

    73     /**

    74      * To save mailbox Provisioned entry value

    75      *

    76      * @param aEntry Provisioned Entry data

    77      */

    78     void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );

    79 

    80     /**

    81      * @see CVoiceMailbox::CheckConfiguration

    82      *

    83      * @param aParams Specifies which mailbox capabilities,

    84      *          the caller wants to check.

    85      * @param aFlags Use TVmbxFeatureCapabilityFlag values for this parameter.

    86      *          Specifies what features client wants to check.

    87 

    88      * @return True if feature(s) enabled.

    89      */

    90     TBool CheckConfiguration( const TVoiceMailboxParams& aParams,

    91                                  const TInt aFlags );

    92 

    93     /**

    94      * Check Entry writable

    95      *

    96      * @param aParams params of Entry data

    97      * @return ETrue if entry is writable

    98      */

    99     TBool IsWritable( const TVoiceMailboxParams& aParams );

   100  

   101 private:

   102 

   103     /**

   104      * C++ default constructor.

   105      *

   106      * @param aProvider Reference to MVmbxResourceProvider

   107      */

   108     CVmbxCsVoiceEngine( MVmbxResourceProvider& aProvider );

   109 

   110     /**

   111      * By default Symbian 2nd phase constructor is private.

   112      *

   113      */

   114     void ConstructL();

   115 

   116     /**

   117      * Queries where to save and then saves

   118      *

   119      * @param in aEntry Entry data

   120      * @param aShowNotesAllowed Provision mode is used to decide whether show

   121      *          saved notification UI dialog. If aShowNotesAllowed is EFalse,

   122      *          saved notification UI dialog will not show. 

   123      */

   124     void SaveEntryToPhoneL( const CVoiceMailboxEntry& aEntry,

   125                             TBool aShowNotesAllowed );

   126 

   127     /**

   128      * For saving to place that user selects

   129      *

   130      * @param in aEntry Entry data

   131      * @param aShowNotesAllowed Provision mode is used to decide whether show

   132      *          saved notification UI dialog. If aShowNotesAllowed is EFalse,

   133      *          saved notification UI dialog will not show. 

   134      */

   135     void SaveEntryToSimL( const CVoiceMailboxEntry& aEntry, 

   136                           TBool aShowNotesAllowed );

   137 

   138     /**

   139      * Returns Sim writable or not

   140      *

   141      * @return ETrue if writable

   142      */

   143     TBool IsSimWritable();

   144 

   145 private: // data

   146 

   147     /**

   148      * CVmbxSimHandler

   149      * Own.

   150      */

   151     CVmbxSimHandler* iSimHandler;

   152     };

   153 

   154 #endif  // C_VMBXCSVOICEENGINE_H