1 /*

     2 * Copyright (c) 2006 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:  Interface for settings related operations

    15 *

    16 */

    17 

    18 

    19 #ifndef MCASETTINGSPC_H

    20 #define MCASETTINGSPC_H

    21 

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 #include "MCASettings.h"

    26 #include "TEnumsPC.h"

    27 

    28 

    29 // FORWARD DECLARATION

    30 class CIMPSSAPSettings;

    31 

    32 

    33 

    34 //Class Declaration

    35 /**

    36  *  Interface for internal settings handler.

    37  *  @lib CAEngine.lib

    38  *  @since 3.2

    39  */

    40 

    41 class MCASettingsPC

    42     {

    43 

    44     public:

    45 

    46         /**

    47          * Retrieves value.

    48          * @param aSetting specifies the wanted setting.

    49          * @param aSAPSettings - SAP Settings.

    50          * @return Boolean value.

    51          */

    52         virtual TBool GetBoolValuePC( TEnumsPC::TCASettingValues aSetting,

    53                                       CIMPSSAPSettings* aSAPSettings /* = NULL*/ ) = 0;

    54 

    55         /**

    56          * Retrieves value.

    57          * @param aSetting specifies the wanted setting.

    58          * @param aSAPSettings - SAP Settings.

    59          * @return Integer value.

    60          */

    61         virtual TInt GetIntValuePC( TEnumsPC::TCASettingValues aSetting,

    62                                     CIMPSSAPSettings* aSAPSettings /* = NULL*/ ) = 0;

    63 

    64         /**

    65          * Retrieves value..

    66          * @return Bool value.

    67          */

    68         virtual TBool IsAlphabeticalPC( CIMPSSAPSettings* aSAPSettings /* = NULL */ ) = 0;

    69 

    70         /**

    71          * Retrieves value.

    72          * Ownership is transferred to caller!!!

    73          * @param aSetting specifies the wanted setting.

    74          * @param aSAPSettings - SAP Settings.

    75          * @return String value.

    76          */

    77         virtual HBufC* GetSapSettingValuePCL( TEnumsPC::TCASettingStrings aSetting,

    78                                               CIMPSSAPSettings* aSAPSettings  = NULL ) = 0;

    79 

    80         /**

    81          * Sets a value.

    82          * @param aSetting specifies the wanted setting.

    83          * @param aValue specifies the value we want to store.

    84          * @param aIgnoreRollback Don't perform rollback operation on these

    85          * @ aSAPSettings - SAP Settings.

    86          *                        errors

    87          *        NULL if rollback is wanted in every error situation.

    88          */

    89         virtual void SetBoolValuePCL( TEnumsPC::TCASettingValues aSetting,

    90                                       TBool aValue, RArray<TInt>* aIgnoreRollback  = NULL,

    91                                       CIMPSSAPSettings* aSAPSettings  = NULL ) = 0;

    92 

    93         /**

    94          * Sets a value.

    95          * @param aSetting specifies the wanted setting.

    96          * @param aValue specifies the value we want to store.

    97          * @param aIgnoreRollback Don't perform rollback operation on these

    98          *                        errors

    99          *        NULL if rollback is wanted in every error situation.

   100          * @param aSAPSettings - SAP Settings.

   101          */

   102         virtual void SetIntValuePCL( TEnumsPC::TCASettingValues aSetting, TInt aValue,

   103                                      RArray<TInt>* aIgnoreRollback, /* = NULL*/

   104                                      CIMPSSAPSettings* aSAPSettings /* = NULL*/ ) = 0;

   105 

   106 

   107         /**

   108          * Sets a value.

   109          * @param aSetting specifies the wanted setting.

   110          * @param aValue specifies the value we want to store.

   111          * @param aIgnoreRollback Don't perform rollback operation on

   112          *                        these errors

   113          *        NULL if rollback is wanted in every error situation.

   114          * @param aSAPSettings - SAP Settings.

   115          */

   116         virtual void SetSapSettingValuePCL( TEnumsPC::TCASettingStrings aSetting,

   117                                             const TDesC& aValue, RArray<TInt>* aIgnoreRollback = NULL ,

   118                                             CIMPSSAPSettings* aSAPSettings = NULL   ) = 0;

   119 

   120 

   121 

   122         /**

   123         * Flushes data from memory to persistent storage

   124         */

   125         virtual void FlushDataPC( ) = 0;

   126 

   127         /**

   128         * Sets the default Sap

   129         * @param aSAPSettings - SAP Settings.

   130         */

   131         virtual void SetDefaultSapL( CIMPSSAPSettings* aSAPSettings ) = 0 ;

   132 

   133         /**

   134         * Sets a value.

   135         * @param aSetting specifies the wanted setting.

   136         * @param aValue specifies the value we want to store.

   137         */

   138         virtual void SetValueL( TEnumsPC::TCASettingValues aSetting, TBool aValue ) = 0;

   139 

   140         /**

   141          * Destructor

   142          */

   143 

   144         virtual ~MCASettingsPC() {};

   145 

   146 

   147     };

   148 

   149 

   150 #endif // MCASETTINGSPC_H

   151 

   152 // End of File