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:   MNcdEngineConfiguration declaration

    15 *

    16 */

    17 

    18 

    19 #ifndef M_NCDENGINECONFIGURATION_H

    20 #define M_NCDENGINECONFIGURATION_H

    21 

    22 class CNcdKeyValuePair;

    23 

    24 /**

    25  * Interface that provides access to engine's configuration.

    26  *

    27  */

    28 class MNcdEngineConfiguration

    29     {

    30 public:

    31 

    32     /**

    33      * Type getter (vanilla, variant etc.)

    34      *

    35      * @return Engine's type

    36      */

    37     virtual const TDesC& EngineType() const = 0;

    38     

    39     /**

    40      * Version getter

    41      *

    42      * @return Version

    43      */

    44     virtual const TDesC& EngineVersion() const = 0;

    45     

    46     /**

    47      * UID getter

    48      *

    49      * @return UID

    50      */

    51     virtual const TDesC& EngineUid() const = 0;

    52 

    53     /**

    54      * Provisioning getter

    55      *

    56      * @return Provisioning

    57      */

    58     virtual const TDesC& EngineProvisioning() const = 0;

    59     

    60     

    61     /**

    62      * Installation drive getter

    63      *

    64      * @return Installation drive letter and a colon

    65      */

    66     virtual const TDesC& EngineInstallDrive() const = 0;

    67         

    68     

    69     /**

    70      * Temp drive number getter

    71      *

    72      * @return Temp drive number

    73      */

    74     virtual TInt EngineTempDrive() const = 0;       

    75 

    76     /**

    77      * Client's data path getter

    78      *

    79      * Client's data files (eg. downloaded content files)

    80      * should be stored to this directory before they

    81      * are installed.

    82      *

    83      * @param aClientId Client's ID

    84      * @param aTemp ETrue if the path should be temp data path

    85      * @return Client's data path

    86      */

    87     virtual HBufC* ClientDataPathLC(

    88         const TDesC& aClientId, 

    89         TBool aTemp ) = 0;

    90     

    91     /**

    92      * Tells whether engine uses fixed access point defined in config file.

    93      *

    94      * @return ETrue If engine uses fixed ap, otherwise false.

    95      */        

    96     virtual TBool UseFixedAp() const = 0;

    97          

    98     /**

    99      * Return the details of the fixed access point if such is used.

   100      *

   101      * @return The details.

   102      */

   103     virtual const RPointerArray<CNcdKeyValuePair>& FixedApDetails() const = 0;

   104     

   105     /**

   106      * Clears client's data files (eg. downloaded but not 

   107      * installed content files)

   108      *

   109      * @param aClientId Client's ID

   110      * @param if ETrue, temp files are deleted. Otherwise data files are deleted

   111      */    

   112     virtual void ClearClientDataL( const TDesC& aClientId, TBool aTemp ) = 0;        

   113         

   114 protected:

   115 

   116     /**

   117      * Destructor

   118      */

   119     virtual ~MNcdEngineConfiguration()

   120         {

   121         }

   122     };

   123 

   124 #endif // M_NCDENGINECONFIGURATION_H