serviceproviders/sapi_contacts_vpbk/inc/contactprovider.h
author William Roberts <williamr@symbian.org>
Sun, 14 Mar 2010 13:12:13 +0000
branchCompilerCompatibility
changeset 49 93bab755042a
parent 19 989d2f495d90
permissions -rw-r--r--
Automatic merge from PDK_3.0.h

/*
* Copyright (c) 2006-2007 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the License "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Loads the contact service
*
*/

#ifndef C_CCONTACTPROVIDER_H
#define C_CCONTACTPROVIDER_H

#include <liwserviceifbase.h>

/**
 * CContactProvider - inherits the CLiwServiceIfBase to Load the contact
 * service class.
 */
class CContactProvider : public CLiwServiceIfBase
    {
    public:
        /**
         * Two-phased constructor.
         * @return CContactProvider*
         */
        static CContactProvider* NewL();
        /**
         * Destructor
         */
        ~CContactProvider();

    private:
        /**
         * Default constructor.
         */
        CContactProvider();

    public:
       /**
        * Called by the AIW framework to initialise provider with necessary information
        * from the Service Handler. This method is called when the consumer makes
        * the attach operation.
        *
        * @param aFrameworkCallback Framework provided callback for provider to send
        *                           events to framework.
        * @param aInterest List of criteria items which invoked the provider.
        */
        virtual void InitialiseL( MLiwNotifyCallback& aFrameworkCallback,
                                  const RCriteriaArray& aInterest );
       /**
        * Executes generic service commands included in criteria.
        *
        * @param aCmdId Command to be executed.
        * @param aInParamList Input parameters, can be an empty list.
        * @param aOutParamList Output parameters, can be an empty list.
        * @param aCmdOptions Options for the command, see KLiwOpt* in LiwCommon.hrh.
        * @param aCallback Callback for asynchronous command handling, parameter checking, etc.
        * @leave KErrArgument Callback is missing when required.
        * @leave KErrNotSupported No provider supports service.
        */
        virtual void HandleServiceCmdL( const TInt& aCmdId,
                                        const CLiwGenericParamList& aInParamList,
                                        CLiwGenericParamList& aOutParamList,
                                        TUint aCmdOptions = 0,
                                        const MLiwNotifyCallback* aCallback = NULL );
    };
#endif // C_CCONTACTPROVIDER_H