/*

* Copyright (c) 2002 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 "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

* which accompanies this distribution, and is available

* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Declaration of class CApDataHandler

*

*/

#ifndef APDATAHANDLER_H

#define APDATAHANDLER_H

// Deprecation warning

#warning This header file has been deprecated. Will be removed in one of the next SDK releases.

//  INCLUDES

#include <commdb.h>

#include <etelmm.h>

#include <ApEngineVer.h>

#include <ApEngineConsts.h>

// FORWARD DECLARATIONS

class CApAccessPointItem;

class CApNetworkItem;

// extra data holder.

typedef struct

    {

        TInt    iIsIpv6Supported;            // Is Ipv6 Supported?

        TBool   iIsFeatureManagerInitialised;// Is FeatureManager Initialised?

        /**

        * Indicates if HSCSD Access point is supported or not.

        */

        TBool   iIsAppHscsdSupport;              

        TInt    iVariant;               /// Local variant value

    }THandlerExtra;

// CLASS DECLARATION

/**

*  Representation of the access point handler.

*  Encapsulates a session with the CommsDB

*  Provides a way to access the database and manipulate its data.

*/

class CApDataHandler :public CBase

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor. Leaves on failure, places instance

        * on cleanup stack.

        * @param aDb a reference to a CCommsDataBase object.

        * @return The constructed CApDataHandler.

        *

        * @deprecated

        */

        IMPORT_C static CApDataHandler* NewLC( CCommsDatabase& aDb );

        /**

        * Destructor.

        *

        * @deprecated

        */

        IMPORT_C virtual ~CApDataHandler();

protected:      // Constructors

        /**

        * C++ default constructor.

        *

        * @deprecated

        */

        IMPORT_C CApDataHandler();

        /**

        * Second-phase constructor.

        *

        * @deprecated

        */

        IMPORT_C void ConstructL( CCommsDatabase& aDb );

    private:

    public: // New functions

        // query

        /**

        * Reads up one access point's data from the database.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, function leaves with error code.

        * <br>Error conditions:

        *   - Insufficient memory,

        *   - AP does not exists,

        *   - Server connection failure.

        *

        * @param aUid The Uid of the access point to be read

        * @param aApItem A reference to a CApAccessPointItem to hold the data.

        * @return no return value.

        *

        * @deprecated

        */

        IMPORT_C void AccessPointDataL( TUint32 aUid,

                                      CApAccessPointItem& aApItem );

        // update

        /**

        * Updates data stored in an existing access point.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, no data is stored.

        * <br>Error conditions:

        *   - Insufficient memory

        *   - Server connection failure

        *   - Lock already present by other task

        *   - Uid does not exists.

        *   - Attempting to update read-only records will result

        *     in KErrAccessDenied

        *

        * @param aApItem A reference to a CApAccessPointItem holding the data

        * @param aNameChanged a reference to a TBool that will indicate

        * whether the name has changed or not.

        * @return No return value.

        *

        * @deprecated

        */

        IMPORT_C void UpdateAccessPointDataL( CApAccessPointItem& aApItem,

                                              TBool& aNameChanged );

        // Creating new AP

        /**

        * Creates a copy of a previously existing access point.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, no access point will be created.

        * <br>Error conditions:

        *   - Insufficient memory

        *   - Server connection failure.

        *   - Lock already present by other task.

        *   - Access point does not exist.

        *   - Attempting to create new in protected tables will results

        *     in KErrAccessDenied

        *

        * @param aBaseId The UID of the existing access point to copy from.

        * @return The Uid of the newly constructed and saved access point.

        *

        * @deprecated

        */

        IMPORT_C TUint32 CreateCopyFromL( TUint32 aBaseId );

        /**

        * Create a new access point from supplied data

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * The name of the AP will be corrected to be unique if necessary and

        * returned in the passed aApItem.

        * In case of error, no access point will be created and the passed

        * one will remain intact.

        * <br>Error conditions:

        *   - Insufficient memory

        *   - Server connection failure.

        *   - Lock already present by other task.

        *   - Attempting to create new in protected tables will result

        * in KErrAccessDenied

        *

        * @param aApItem Reference to a CApAccessPointItem holding the data

        * @return The UID of the newly created and saved access point.

        *

        * @deprecated

        */

        IMPORT_C TUint32 CreateFromDataL( CApAccessPointItem& aApItem );

        // Remove

        /**

        * Removes the given access point from the database.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, access point will not be removed.

        * <br>Error conditions:

        *   - Insufficient memory,

        *   - Server connection failure.

        *   - Lock already present by other task.

        *   - Access point does not exist.

        *   - Attempting to remove read-only records will result

        * in KErrAccessDenied

        *

        * @param aUid The UID of the access point to remove.

        * @return no return value.

        *

        * @deprecated

        */

        IMPORT_C void RemoveAPL( TUint32 aUid );

        // Getting default access point

        /**

        * Reads the UID of the default access point.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        *   - Access point does not exists.

        *

        * @param aIsWAP A boolean indicating whether to read the default

        * WAP or the default IAP/ISP (dep. on the database type) access point.

        * @return The UID of the default access point.

        *

        * @deprecated

        */

        IMPORT_C TUint32 DefaultL( TBool aIsWap ) const;

        // Setting as default

        /**

        * Sets the default access point.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        *   - Access point does not exists.

        *   - Given Access Point is not of the desired type.

        *

        * @param aUid The UID of the access point to be set as default.

        * @param aIntendedType The default type ( IAP, WAP, Both).

        *

        * @deprecated

        */

        IMPORT_C void SetAsDefaultL(TUint32 aUid,

                                    TCommsDbIspType aIntendedType );

        // Setting preferences

        /**

        * Sets the access point preference. Can be used only if the

        * database type is IAP.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        * Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

        * @param aRank The ranking of the connection preference.

        * @param aDircetion Specifies the direction of this connection

        * preference

        * @param aBearers The bearer set being valid for this connection

        * preference

        * @param aPrompt Enum value indicating whether or not the user

        * should be prompted or warned on connection

        * @param aIAP The identifier of the preferred IAP for this connection.

        * @param aOverwrite Boolean value indicating that if a same record

        * present, overwrite it or not.

        *

        * @deprecated

        */

        IMPORT_C void SetPreferredIfDbIapTypeL

                                    (

                                    TUint32 aRank,

                                    TCommDbConnectionDirection aDirection,

                                    TUint32 aBearers,

                                    TCommDbDialogPref aPrompt,

                                    TUint32 aIAP,

                                    TBool aOverwrite

                                    );

        /**

        * Sets the access point preference. Can be used only if the

        * database type is ISP.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        * Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

        * @param aRank The ranking of the connection preference.

        * @param aDircetion Specifies the direction of this connection

        * preference

        * @param aBearers The bearer set beeing valid for this connection

        * preference

        * @param aPrompt Enum value indicating whether or not the user

        * should be prompted or warned on connection

        * @param aISP The identifier of the preferred ISP for this connection.

        * @param aChargeCard Identifier of the preferred chargecard for

        * this connection.

        * @param aServiceType The type of the service.

        * @param aOverwrite Boolean value indicating that if a same record is

        * present, overwrite it or not.

        *

        * @deprecated

        */

        IMPORT_C void SetPreferredIfDbIspTypeL

                                    (

                                    TUint32 aRank,

                                    TCommDbConnectionDirection aDirection,

                                    TUint32 aBearers,

                                    TCommDbDialogPref aPrompt,

                                    TUint32 aISP,

                                    TUint32 aChargeCard,

                                    const TDesC& aServiceType,

                                    TBool aOverwrite

                                    );

        /**

        * Gets the access point preference. Can be used only if the

        * database type is IAP.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        * @param aRank The ranking of the desired connection preference.

        * @param aDircetion Specifies the direction of the desired connection

        * preference

        * @param aBearers The bearer set beeing valid for this connection

        * preference

        * @param aPrompt Enum value indicating whether or not the user

        * should be prompted or warned on connection

        * @param aIAP The identifier of the preferred IAP for this

        * connection preference.

        *

        * @deprecated

        */

        IMPORT_C void GetPreferredIfDbIapTypeL

                                    (

                                    TUint32 aRank,

                                    TCommDbConnectionDirection aDirection,

                                    TUint32& aBearers,

                                    TUint32& aPrompt,

                                    TUint32& aIAP

                                    );

        /**

        * Gets the access point preference. Can be used only if the

        * database type is ISP.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        * @param aRank The ranking of the desired connection preference.

        * @param aDircetion Specifies the direction of the desired connection

        * preference

        * @param aBearers The bearer set beeing valid for this connection

        * preference

        * @param aPrompt Enum value indicating whether or not the user

        * should be prompted or warned on connection

        * @param aISP The identifier of the preferred ISP for this

        * connection preference.

        * @param aChargeCard Identifier of the preferred chargecard for

        * this connection preference.

        * @return The type of the service.

        *

        * @deprecated

        */

        IMPORT_C const TDesC& GetPreferredIfDbIspTypeL

                                    (

                                    TUint32 aRank,

                                    TCommDbConnectionDirection aDirection,

                                    TUint32& aBearers,

                                    TUint32& aPrompt,

                                    TUint32& aISP,

                                    TUint32& aChargeCard

                                    );

        // Getting default access point

        /**

        * Reads the UID of the default access point.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, leaves with CommsDb or system error codes.

        * <br>Error conditions:

        *   - Insufficient memory;

        *   - Server connection failure;

        *   - Lock already present;

        *   - Access point does not exists.

        *

        * @param aIsWAP A boolean indicating whether to read the default

        * WAP or the default IAP/ISP (dep. on the database type) access point.

        * @param aReadOnly A TBool passed by reference to hold whether the

        * the default access point record is read-only or not.

        * @return The UID of the default access point.

        *

        * @deprecated

        */

        IMPORT_C TUint32 DefaultL( TBool aIsWap, TBool& aReadOnly )const;

        // Remove

        /**

        * Removes the given network group from the database.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, network group will not be removed.

        * <br>Error conditions:

        *   - Insufficient memory,

        *   - Server connection failure.

        *   - Lock already present by other task.

        *   - network group does not exist.

        *   - Attempting to remove read-only records will result

        * in KErrAccessDenied

        *

        * @param aUid The UID of the network group to remove.

        * @return no return value.

        *

        * @deprecated

        */

        IMPORT_C void RemoveNetworkL( TUint32 aUid );

        /**

        * Creates a network group from the data.

        * Expects that CApDataHandler has been created and the database had

        * been opened.

        * In case of error, network group will not be created.

        * <br>Error conditions:

        *   - Insufficient memory,

        *   - Server connection failure.

        *   - Lock already present by other task.

        *   - network group does not exist.

        *   - Attempting to remove read-only records will result

        * in KErrAccessDenied

        *

        * @param aNetwork The network item to create/write into db.

        * @return no return value.

        *

        * @deprecated

        */

        IMPORT_C void CreateNetworkL( CApNetworkItem& aNetwork );

        /**

        * Reads up a network part of the access point

        * Network is identified by the iNetworkId of the passed access point

        *

        * @deprecated

        */

        IMPORT_C void ReadNetworkPartL( CApAccessPointItem& aItem );

        /**

        * Reads up a network 

        * Network is identified by passed uid

        *

        * @deprecated

        */

        IMPORT_C void ReadNetworkL( TUint32 aUid, CApNetworkItem& aNetwork );

    protected:  // New functions

        /**

        * Reads the WAP part of the data from the database.

        * In case of error, leaves with CommDb error codes.

        * @param aWapId The UID of the Access Point to read the data from.