epoc32/include/app/MVPbkContactCopyObserver.h
branchSymbian3
changeset 4 837f303aceeb
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
       
     1 /*
       
     2 * Copyright (c) 2004-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:  Virtual Phonebook observer interface for contact copying.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MVPBKCONTACTCOPYOBSERVER_H
       
    20 #define MVPBKCONTACTCOPYOBSERVER_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32cmn.h>
       
    24 #include <e32def.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class MVPbkContactOperationBase;
       
    28 class MVPbkContactLinkArray;
       
    29 
       
    30 /**
       
    31  * Virtual Phonebook contact copy observer interface.
       
    32  * This interface is used to signal the client of the copying
       
    33  * operations events. 
       
    34  */
       
    35 class MVPbkContactCopyObserver
       
    36     {
       
    37     public: // Interface
       
    38         /**
       
    39          * Called when the contact has been successfully commited or
       
    40          * copied. Caller takes the ownership of results.
       
    41          *
       
    42          * @param aOperation    The operation that this observer monitors.
       
    43          * @param aResults  An array of links to copied contacts.
       
    44          *                  Caller takes the ownership of the 
       
    45          *                  object immediately.
       
    46          */
       
    47         virtual void ContactsSaved( MVPbkContactOperationBase& aOperation,
       
    48             MVPbkContactLinkArray* aResults ) = 0;
       
    49         
       
    50         /**
       
    51          * Called when there was en error while saving contact(s).
       
    52          * @param aOperation    The operation that this observer monitors.
       
    53          * @param aError an error that occured.
       
    54          */
       
    55         virtual void ContactsSavingFailed( 
       
    56                 MVPbkContactOperationBase& aOperation, TInt aError ) = 0;
       
    57 
       
    58         /**
       
    59          * Returns an extension point for this interface or NULL.
       
    60          * @param aExtensionUid Uid of extension
       
    61          * @return Extension point or NULL
       
    62          */
       
    63         virtual TAny* ContactCopyObserverExtension( 
       
    64                 TUid /*aExtensionUid*/ ) { return NULL; }
       
    65 
       
    66     protected:  // Destructor
       
    67         /**
       
    68          * Destructor.
       
    69          */
       
    70         virtual ~MVPbkContactCopyObserver() { }
       
    71 
       
    72     };
       
    73     
       
    74 #endif // MVPBKCONTACTCOPYOBSERVER_H
       
    75 
       
    76 // End of File