1 /*

     2 * Copyright (c) 2005 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:  Contact lists transaction manager abstract interface

    15 *

    16 */

    17 

    18 #ifndef __MPENGCONTACTLISTTRANSACTIONMANAGER_H__

    19 #define __MPENGCONTACTLISTTRANSACTIONMANAGER_H__

    20 

    21 

    22 // INCLUDES

    23 #include <e32base.h>

    24 #include <badesca.h>

    25 

    26 

    27 // FORWARD DECLARATIONS

    28 class MPEngOutgoingTransactionHandler;

    29 class MDesCArray;

    30 class CPEngContactListSettings;

    31 

    32 

    33 // CLASS DECLARATION

    34 /**

    35  * Contact lists transaction manager abstract interface

    36  *

    37  * @lib PEngListLib2

    38  * @since 3.0

    39  */

    40 class MPEngContactListTransactionManager

    41     {

    42     public:

    43 

    44         /**

    45          * Handles completion of contact list

    46          * environment synhronization.

    47          *

    48          * Non-existing contact lists are removed and new contact

    49          * lists are added to the contact list manager

    50          * Sets contact list manager as synchronized.

    51          *

    52          * @since 3.0

    53          * @param aExistingLists List of lists existing on the server.

    54          * @param aDefaultList Id of the default list.

    55          */

    56         virtual void CompleteEnviromentSyncL( CDesCArray& aExistingLists,

    57                                               const TDesC& aDefaultList,

    58                                               TBool aListsUnsubscribed ) = 0;

    59 

    60         /**

    61          * User domain for the active session.

    62          * KNUllDesC if domain isn't available.

    63          *

    64          * @since 3.0

    65          * @return User domain

    66          */

    67         virtual const TDesC& UserDomain() = 0;

    68 

    69 

    70         /**

    71          * Gets settinsg for default contact list.

    72          * If there is not default contact list, NULL pointer is returned

    73          *

    74          * @since 3.0

    75          * @return default contact list settings or NULL.

    76          */

    77         virtual CPEngContactListSettings* DefaultCntListSettingsOrNull() = 0;

    78 

    79 

    80         /**

    81          * Complete contact list deletion

    82          *

    83          * This function is called when contact list is deleted from

    84          * from network server

    85          *

    86          * @since 3.0

    87          * @param aContactList Id of the deleted contact list

    88          */

    89         virtual void CompleteCntListDeletionL( const TDesC& aContactList ) = 0;

    90 

    91 

    92     protected:

    93 

    94         /**

    95          * Virtual inline destructor.

    96          * Protected to prohibite deletion through interface.

    97          */

    98         virtual ~MPEngContactListTransactionManager() {};

    99 

   100     };

   101 

   102 #endif //   __MPENGCONTACTLISTTRANSACTIONMANAGER_H__

   103 

   104 // End of File

   105