phoneengine/PhoneCntFinder/ContactService/inc/mphcntstoreloader.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2008 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 loading contact stores.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_MPHCNTSTORELOADER_H
       
    20 #define M_MPHCNTSTORELOADER_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class MPhCntStoreLoaderObserver;
       
    25 
       
    26 /**
       
    27  *  Interface for loading contact stores.
       
    28  *
       
    29  *  @lib phonecntfinder.lib
       
    30  *  @since S60 v9.1
       
    31  */
       
    32 class MPhCntStoreLoader
       
    33     {
       
    34 
       
    35 public:
       
    36 
       
    37     /**
       
    38     * Destructor.
       
    39     */
       
    40     virtual ~MPhCntStoreLoader() { };
       
    41 
       
    42     /**
       
    43      * Checks is the specified contact store loaded.
       
    44      *
       
    45      * @since   S60 v9.1
       
    46      * @param   aContactLink      A contact link containing store to load.
       
    47      * @return  ETrue if store is loaded, EFalse otherwise.
       
    48      */
       
    49     virtual TBool IsContactStoreLoaded( 
       
    50         const TDesC8& aContactLink ) const = 0;
       
    51     
       
    52     /**
       
    53      * Starts to load specified contact store if not yet loaded.
       
    54      * MPhCntStoreLoaderObserver::ContactStoreLoaded is called when contact
       
    55      * store is loaded and ready for use.
       
    56      *
       
    57      * @since   S60 v9.1
       
    58      * @param   aContactLink      A contact link containing store to load.
       
    59      * @param   aObserver         An observer for the loading process.
       
    60      */
       
    61     virtual void LoadContactStoreL( const TDesC8& aContactLink,
       
    62         MPhCntStoreLoaderObserver& aObserver ) = 0;
       
    63     };
       
    64 
       
    65 #endif // M_MPHCNTSTORELOADER_H