phonebookengines/VirtualPhonebook/VPbkSimStoreImpl/inc/CCustomStore.h
branchRCL_3
changeset 63 f4a778e096c2
parent 0 e686773b3f54
equal deleted inserted replaced
62:5b6f26637ad3 63:f4a778e096c2
       
     1 /*
       
     2 * Copyright (c) 2002-2007 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:  A store that uses ETel custom API due to cache in TSY
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef VPBKSIMSTOREIMPL_CCUSTOMSTORE_H
       
    21 #define VPBKSIMSTOREIMPL_CCUSTOMSTORE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include "CBasicStore.h"
       
    25 #include <rmmcustomapi.h>
       
    26 
       
    27 namespace VPbkSimStoreImpl {
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class CCompositeCmdBase;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35 *  A store that uses ETel custom API due to cache in TSY
       
    36 *
       
    37 */
       
    38 NONSHARABLE_CLASS(CCustomStore) : public CBasicStore
       
    39     {
       
    40     public:  // Constructors and destructor
       
    41         
       
    42         /**
       
    43         * Destructor.
       
    44         */
       
    45         virtual ~CCustomStore();
       
    46 
       
    47     public: // New functions
       
    48         
       
    49         /**
       
    50         * Returns the custom API subsession
       
    51         * @return the custom API subsession
       
    52         */
       
    53         inline RMmCustomAPI& CustomAPI();
       
    54 
       
    55     public: // Functions from base classes
       
    56 
       
    57         /**
       
    58         * From CStoreBase
       
    59         */
       
    60         void OpenETelStoreL();
       
    61 
       
    62         /**
       
    63         * From CStoreBase
       
    64         */
       
    65         void CloseETelStore();
       
    66 
       
    67         /**
       
    68         * From CStoreBase
       
    69         */
       
    70         MVPbkSimCommand* CreateInitCommandL( 
       
    71             MVPbkSimCommandObserver& aObserver );
       
    72 
       
    73     protected:  // New functions
       
    74         
       
    75         /**
       
    76         * Adds a command that waits TSY cache to be ready.
       
    77         * @param aCmdChain the command chain
       
    78         */
       
    79         void AddTSYCacheReadyCmdToChainL( CCompositeCmdBase& aCmdChain );
       
    80 
       
    81     protected:
       
    82 
       
    83         /**
       
    84         * C++ default constructor.
       
    85         * @param aParams the store parameters
       
    86         */
       
    87         CCustomStore( TStoreParams& aParams );
       
    88 
       
    89         /**
       
    90         * By default Symbian 2nd phase constructor is private.
       
    91         */
       
    92         void ConstructL();
       
    93 
       
    94     private:    // Data
       
    95         /// ETel custom API subsession
       
    96         RMmCustomAPI iCustomAPI;
       
    97         /// The ETel/TSY cache status
       
    98         RMmCustomAPI::TPndCacheStatus iCacheStatus;
       
    99     };
       
   100 
       
   101 // INLINE FUNCTIONS
       
   102 inline RMmCustomAPI& CCustomStore::CustomAPI()
       
   103     {
       
   104     return iCustomAPI;
       
   105     }
       
   106 
       
   107 } // namespace VPbkSimStoreImpl
       
   108 #endif      // VPBKSIMSTOREIMPL_CCUSTOMSTORE_H
       
   109             
       
   110 // End of File