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 phased service interface.

    15 *

    16 */

    17 

    18 

    19 #ifndef MPBK2SERVICEPHASE_H

    20 #define MPBK2SERVICEPHASE_H

    21 

    22 // INCLUDES

    23 #include <e32std.h>

    24 

    25 // FORWARD DECLARATIONS

    26 class MVPbkContactLinkArray;

    27 class MVPbkStoreContact;

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32  * Phonebook 2 phased service interface.

    33  */

    34 class MPbk2ServicePhase

    35     {

    36     public: // Interface

    37 

    38         /**

    39          * Destructor.

    40          */

    41         virtual ~MPbk2ServicePhase() {};

    42 

    43         /**

    44          * Launches the phased service.

    45          */

    46         virtual void LaunchServicePhaseL() = 0;

    47 

    48         /**

    49          * Cancels the phased service by force.

    50          */

    51         virtual void CancelServicePhase() = 0;

    52 

    53         /**

    54          * Request the phased service to cancel itself.

    55          *

    56          * @param aExitCommandId    Cancel command id.

    57          */

    58         virtual void RequestCancelL(

    59                 TInt aExitCommandId ) = 0;

    60 

    61         /**

    62          * Notifies of delayed acception.

    63          *

    64          * @param aContactLinkBuffer    Buffer containing accepted

    65          *                              contact links.

    66          */

    67         virtual void AcceptDelayedL(

    68                 const TDesC8& aContactLinkBuffer ) = 0;

    69 

    70         /**

    71          * Notifies of delayed acception.

    72          *

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

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

    75          * 

    76          * @param aContactLinkBuffer    Buffer containing denied

    77          *                              contact links.

    78          */

    79         virtual void DenyDelayedL(

    80                 const TDesC8& aContactLinkBuffer ) = 0;

    81         

    82         /**

    83          * Returns the results.

    84          *

    85          * @return  Results.

    86          */

    87         virtual MVPbkContactLinkArray* Results() const = 0;

    88 

    89         /**

    90          * Returns additional result data if supported.

    91          *

    92          * @return TInt result data or KErrNotSupported.

    93          */

    94         virtual TInt ExtraResultData() const = 0;

    95 

    96         /**

    97          * Takes store contact from the phase.

    98          *

    99          * @return  Results.

   100          */

   101         virtual MVPbkStoreContact* TakeStoreContact() = 0;

   102         

   103         /**

   104          * Returns content of the selected field if supported.

   105          *

   106          * @return field content or NULL.

   107          */

   108         virtual HBufC* FieldContent() const = 0;

   109     };

   110 

   111 #endif // MPBK2SERVICEPHASE_H

   112 

   113 // End of File