homescreensrv_plat/sapi_backstepping/inc/bsserviceprovider.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 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:  Back Stepping Service Provider
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_BS_SERVICE_PROVIDER_H
       
    20 #define C_BS_SERVICE_PROVIDER_H
       
    21 
       
    22 #include <liwserviceifbase.h>
       
    23 
       
    24 /**
       
    25  *  Back Stepping Service Provider
       
    26  *  Serves as a LIW provider for the BS Service Interface.
       
    27  *
       
    28  *  @since S60 v3.2
       
    29  */
       
    30 class CBSServiceProvider : public CLiwServiceIfBase
       
    31     {
       
    32 
       
    33 public:
       
    34 
       
    35     /**
       
    36      * Two-phase constructor.
       
    37      */
       
    38     static CBSServiceProvider* NewL();
       
    39 
       
    40     /**
       
    41      * Destructor.
       
    42      */
       
    43     ~CBSServiceProvider();
       
    44 
       
    45     // from CLiwServiceIfBase
       
    46     /**
       
    47      * Called by the LIW framework to initialise necessary information 
       
    48      * from the Service Handler. This method is called when the consumer makes
       
    49      * the attach operation.
       
    50      *
       
    51      * @since S60 v3.2
       
    52      * @param aFrameworkCallback Framework provided callback
       
    53      * @param aInterest List of criteria items which invoked the provider
       
    54      */
       
    55     void InitialiseL( MLiwNotifyCallback& aFrameworkCallback,
       
    56         const RCriteriaArray& aInterest );
       
    57 
       
    58     /**
       
    59      * Executes generic service commands included in criteria.
       
    60      *
       
    61      * @param aCmdId Command to be executed
       
    62      * @param aInParamList Input parameters, can be an empty list
       
    63      * @param aOutParamList Output parameters, can be an empty list
       
    64      * @param aCmdOptions Options for the command
       
    65      * @param aCallback Callback for asynchronous command handling
       
    66      */
       
    67     void HandleServiceCmdL( const TInt& aCmdId,
       
    68         const CLiwGenericParamList& aInParamList,
       
    69         CLiwGenericParamList& aOutParamList, TUint aCmdOptions = 0,
       
    70         const MLiwNotifyCallback* aCallback = NULL );
       
    71 
       
    72 private:
       
    73 
       
    74     /**
       
    75      * Constructor.
       
    76      */
       
    77     CBSServiceProvider();
       
    78 
       
    79     // error handling
       
    80     /**
       
    81      * Appends error code to output parameter list.
       
    82      *
       
    83      * @param aOutParamList output parameter list
       
    84      * @param aError error code
       
    85      */
       
    86     void HandleErrorL( CLiwGenericParamList& aOutParamList,
       
    87         const TInt aError );
       
    88 
       
    89 private:
       
    90     // data
       
    91 
       
    92     };
       
    93 
       
    94 #endif // C_BS_SERVICE_PROVIDER_H