1 /*

     2 * Copyright (c) 2005-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:  Phonebook 2 application server UI service interface.

    15 *

    16 */

    17 

    18 

    19 #ifndef MPBK2UISERVICE_H

    20 #define MPBK2UISERVICE_H

    21 

    22 // INCLUDES

    23 #include <e32std.h>

    24 #include "Pbk2ServerApp.hrh"

    25 

    26 // FORWARD DECLARATIONS

    27 class MVPbkContactLinkArray;

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32  * Phonebook 2 application server UI service interface.

    33  */

    34 class MPbk2UiService

    35     {

    36     public: // Interface

    37 

    38         struct TServiceResults

    39         {

    40             MVPbkContactLinkArray* iLinkArray;

    41             TInt iExtraData;

    42             HBufC* iFieldContent;

    43         };

    44 

    45         /**

    46          * Destructor.

    47          */

    48         virtual ~MPbk2UiService()

    49                 {}

    50 

    51         /**

    52          * Launches the service.

    53          */

    54         virtual void LaunchServiceL() = 0;

    55 

    56         /**

    57          * Cancels the service.

    58          */

    59         virtual void CancelService() = 0;

    60 

    61         /**

    62          * Accepts the delayed contacts as part of

    63          * the contact set used in the service.

    64          *

    65          * @param aContactLinkBuffer    Accepted contacts.

    66          */

    67         virtual void AcceptDelayedContactsL(

    68                 const TDesC8& aContactLinkBuffer ) = 0;

    69 

    70         /**

    71          * Deny the delayed contacts as part of

    72          * the contact set used in the service.

    73          * 

    74          * Purpose: Sometimes client maybe deny the selected contact, 

    75          * the function is used to deliver the client's feedback to phonebook.

    76          * 

    77          * @param aContactLinkBuffer    Denied contacts.

    78          */

    79         virtual void DenyDelayedContactsL(

    80                 const TDesC8& aContactLinkBuffer) = 0;

    81         

    82         /**

    83          * Exits the service.

    84          *

    85          * @param aExitCommandId    The id of the exit command.

    86          */

    87         virtual void ExitServiceL(

    88                 TInt aExitCommandId ) = 0;

    89 

    90         /**

    91          * Retrieves service results.

    92          *

    93          * @return  Contact links in an array.

    94          */

    95         virtual void ServiceResults(TServiceResults* aResults) const = 0;

    96     };

    97 

    98 #endif // MPBK2UISERVICE_H

    99 

   100 // End of File