phonebookui/Phonebook2/ServerApplication/inc/MPbk2AppService.h
changeset 0 e686773b3f54
equal deleted inserted replaced
-1:000000000000 0:e686773b3f54
       
     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 service interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPBK2APPSERVICE_H
       
    20 #define MPBK2APPSERVICE_H
       
    21 
       
    22 // FORWARD DECLARATIONS
       
    23 class RMessage2;
       
    24 
       
    25 // CLASS DECLARATION
       
    26 
       
    27 /**
       
    28  * Phonebook 2 application server service interface.
       
    29  */
       
    30 class MPbk2AppService
       
    31     {
       
    32     public: // Interface
       
    33 
       
    34         /**
       
    35          * Destructor.
       
    36          */
       
    37         virtual ~MPbk2AppService()
       
    38                 {}
       
    39 
       
    40         /**
       
    41          * Launches the service.
       
    42          *
       
    43          * @param aMessage  The message object containing further info.
       
    44          */
       
    45         virtual void LaunchServiceL(
       
    46                 const RMessage2& aMessage ) = 0;
       
    47 
       
    48         /**
       
    49          * Cancels the service.
       
    50          *
       
    51          * @param aMessage  The message object containing further info.
       
    52          */
       
    53         virtual void CancelService(
       
    54                 const RMessage2& aMessage ) = 0;
       
    55 
       
    56         /**
       
    57          * Gets results of the service.
       
    58          *
       
    59          * @param aMessage  The message object the results are written into.
       
    60          */
       
    61         virtual void GetResultsL(
       
    62                 const RMessage2& aMessage ) = 0;
       
    63 
       
    64         /**
       
    65          * Gets result size.
       
    66          *
       
    67          * @param aMessage  The message object the size is written into.
       
    68          */
       
    69         virtual void GetResultSizeL(
       
    70                 const RMessage2& aMessage ) = 0;
       
    71 
       
    72         /**
       
    73          * Notifies the service that the client side has processed the
       
    74          * exit notification. The answer is in the given message,
       
    75          * the service will inspect the message and decide whether to
       
    76          * exit or not.
       
    77          *
       
    78          * @param aMessage  The message containing further info.
       
    79          */
       
    80         virtual void TryExitServiceL(
       
    81                 const RMessage2& aMessage ) = 0;
       
    82 
       
    83         /**
       
    84          * Notifies the service that the client side has processed the
       
    85          * accept notification. The answer is in the given message,
       
    86          * the service will inspect the message and decide whether to
       
    87          * accept or not.
       
    88          *
       
    89          * @param aMessage  The message containing further info.
       
    90          */
       
    91         virtual void TryAcceptServiceL(
       
    92                 const RMessage2& aMessage ) = 0;
       
    93     };
       
    94 
       
    95 #endif // MPBK2APPSERVICE_H
       
    96 
       
    97 // End of File