// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "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:

// Comms Data Type Definitions version 1.1

// Container classes expressing Symbian OS Comms Data Types that can be stored in the Comms Repository

// Type Definitions are version controlled.  New versions may be introduced from time to time.

// Then older versions are marked as deprecated and given a planned removal date.

// This version introduced with Release 9.1

// 

//

/**

 @file

 @publishedAll

 @released

*/

#if (!defined COMMSDATTYPESV1_1_H)

#define       COMMSDATTYPESV1_1_H

#include <metadatabase.h>

#include <commsdattypeinfov1_1.h>

#include <cdbcols.h>

#include <dial.h>

#include <etelqos.h>

namespace CommsDat

{

//

// COMMSDAT RECORD BASE CLASS

// Contains fields common to all records

//

class CCDRecordBase : public CMDBRecordBase

/**

Base class for wrapper containers for supported CommsDat recordtypes

Alternatively the class CMDBGenericRecord can be used to express any record.

@publishedAll

@released

*/

	{

	public:

		IMPORT_C CCDRecordBase(TMDBElementId aElementId); 			//< Import CCDRecordBase constructor from another DLL.

		IMPORT_C static CMDBRecordBase* RecordFactoryL(TMDBElementId); //< Import function RecordFactoryL from another DLL.				 

		IMPORT_C static CMDBRecordBase* CreateCopyRecordL(CMDBRecordBase& aCopyFromRecord); //< Import function CreateCopyRecordL from another DLL.

        void ConstructL();

	protected:

		EXP_DATA_VTABLE

	public:

		// Element members

		CMDBField<TInt>	 iRecordTag; 	//<User-defined numeric tag for this record.  Should be unique in this table.   

        CMDBField<TDesC> iRecordName; 	//< User-defined name for this record.  Should be unique in this table.

	private:

        CCDRecordBase(){}

	};

#ifdef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

//

// BASE CLASS FOR ALL SERVICE RECORDS

// Contains fields common to all service records

//

/**

@publishedAll

@released

*/

class CCDParamsRecordBase : public CCDRecordBase

	{

	public:

		// Constructor

		/**

		@internalComponent

		*/

		CCDParamsRecordBase();

		/**

		@internalComponent

		*/

		CCDParamsRecordBase(TMDBElementId aElementId);

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;}

	protected:

		DATA_VTABLE

   	public:

		// Field Declarations shared by all Params Records

		CMDBField<TUint32>		iSTypeId;

	private:

	    static const SRecordTypeInfo* const iRecordInfo;

	};

#endif

//

// BASE CLASS FOR ALL SERVICE RECORDS

// Contains fields common to all service records

//

/**

@publishedAll

@released

*/

class CCDServiceRecordBase : public CCDRecordBase

	{

	public:

		// Constructor

		/**

		@internalComponent

		*/

		CCDServiceRecordBase();

		/**

		@internalComponent

		*/

		CCDServiceRecordBase(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;}

	protected:

		DATA_VTABLE

   	public:

		// Field Declarations shared by all Service Records

		CMDBField<TBool>	iServiceEnableLlmnr;	//< Specifies whether Link-local multicast name resolution is enabled.

	private:

	    static const SRecordTypeInfo* const iRecordInfo;

	};

//

// BASE CLASS FOR ALL BEARER RECORDS

// Contains fields common to all bearer records

//

/**

@publishedAll

@released

*/

class CCDBearerRecordBase : public CCDRecordBase

	{

	public:

		// Constructor

		/**

		@internalComponent

		*/

		CCDBearerRecordBase();

		/**

		@internalComponent

		*/

		CCDBearerRecordBase(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;} 

	protected:

		DATA_VTABLE

    public:

		// Field Declarations shared by all Bearer Records

        CMDBField<TDesC>					iBearerAgent; //< Name of the agent to be used by a particular bearer

	private:

        static const SRecordTypeInfo* const iRecordInfo;

	};

class CCDIAPRecord;

//

// 02/  CONNECTION PREFERENCES RECORD

//

// Forward declaration

/**

@publishedAll

@released

*/

class CCDConnectionPrefsRecord : public CCDRecordBase

	{

	public :

		/**

		@internalComponent

		*/

		CCDConnectionPrefsRecord();

		/**

		@internalComponent

		*/

		CCDConnectionPrefsRecord(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;} 

        DATA_VTABLE

	public :

		// Member Elements

		CMDBField<TUint32>		        iRanking; 			//< IAP ranking- An IAP with ranking of 1 is attempted first and so forth. An IAP with a ranking of 0 will never be attempted for connection.

		CMDBField<TCommDbConnectionDirection>	iDirection; //< Specifies the direction of a connection.	

		CMDBField<TUint32>		        iBearerSet;   		//< Bearers which can be used for a connection.

		CMDBField<TUint32>		        iDialogPref;  		//< Specifies whether the system, on a connection attempt being started, should: a) offer the user a menu of the available connection options; b) warn that a connection is about to take place; c) connect without further notifying the user. Takes a value from the enum TCommDbDialogPref. Default value is ECommDbDialogPrefUnknown. 

		CMDBRecordLink<CCDIAPRecord>	iDefaultIAP;  		//< The record id of the preferred IAP to connect to.

    private:

        static const SRecordTypeInfo* const iRecordInfo;

	};

//Forward defines

class CCDLocationRecord;

class CCDModemBearerRecord;

class CCDNetworkRecord;

class CCDAgentLookupRecord;

class CCDWAPAccessPointRecord;

class CCDAccessPointRecord;

#ifdef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

class CCDTierRecord;

#endif

//

// 03/  GLOBAL SETTINGS RECORD

//

/**

@publishedAll

@released

*/

class CCDGlobalSettingsRecord : public CCDRecordBase

	{

	public :

		// Constructor

		/**

		@internalComponent

		*/

		CCDGlobalSettingsRecord();

		/**

		@internalComponent

		*/

		CCDGlobalSettingsRecord(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;}

		DATA_VTABLE

	 public:

		CMDBRecordLink<CCDWAPAccessPointRecord>		                        iWAPAccessPoint; 		

		CMDBField<TUint32>                                                  iMaxConnectionAttempts;				//< Number of attempts to establish a connection.

		CMDBField<TUint32>                                                  iMaxRedialAttempts;					//< Maximum redial attempts before report failure to user.

		CMDBField<TUint32>                                                  iSMSBearer;							//< Default bearer for SMS on the phone.

		CMDBField<TUint32>                                                  iSMSReceiveMode;					//< Clients (SMS Stack on the phone) can receive an SMS either before or after the message has been stored. If the client receives a new message, which the phone has already stored and has acknowledged, then the client does not have to do anything further. If the client receives an unstored new message which the phone has not acknowledged, then the client has the responsibility of attempting to store the message and then either "acking" or "nacking" that message to the network.

		CMDBField<TUint32>                                                  iGPRSAttachMode;					//< Determines when the GPRS terminal should attach to the network. i.e. attach at the boot-up of the device or at a later time.

		CMDBField<TUint32>                                                  iAcceptIncomingGPRS;				//< Specifies whether or not to allow incoming requests for PDP context activation to be automatically accepted (when there is a waiting application).

		CMDBField<TUint32>                                                  iGPRSClassCBearer;				//< The preferred bearer when the device (phone) is forced into GPRS Class C operation.

		CMDBRecordLink<CCDModemBearerRecord>                                iModemForDataAndFax;

		CMDBRecordLink<CCDModemBearerRecord>                                iModemForPhoneServicesAndSMS;

		CMDBRecordLink<CCDLocationRecord>                                   iLocationForDataAndFax;				//< Default local location info for data and fax calls.

		CMDBRecordLink<CCDLocationRecord>                                   iLocationForPhoneServicesAndSMS;	//< Sets the default location from which you are dialling for phone services such as a SMS service

		CMDBField<TUint32>							                        iMaxMBufHeap;						//< Maximum RMBuf heap size.

		CMDBRecordLink<CCDAgentLookupRecord>                                iDefaultAgent;						//< Record id of an agent from the AgentLookup table.

		CMDBRecordLink<CCDNetworkRecord>                                    iDefaultNetwork;					//< Default network to connect to.

		CMDBField<TDesC>                                                    iBearerAvailabilityCheckTSY;		//< The name of the TSY that should be used for bearer availability checking. If this global setting is not found then the TSY specified in ModemBearer is used.

		//This field differentiate the Bravo selection from the 399 selection

		//(needed for implicit scenarios where prefs are not available)

		CMDBRecordLink<CCDAccessPointRecord>								iDefaultSnap;						//<CDMA PARAMETER- Not currently supported.

		//if SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

		//@deprecated use CCDTierRecord::iPromptUser instead

		CMDBField<TBool>													iPromptForSnap; 

		//endif

#ifdef SYMBIAN_NON_SEAMLESS_NETWORK_BEARER_MOBILITY

		CMDBRecordLink<CCDTierRecord>                                       iDefaultTier;

#endif

CMDBField<TCommsDatWlanRegDomain>											iRegulatoryDomain;

		CMDBField<TBool>                                                  	iWmmEnabled;

		CMDBField<TBool>													iEnableCountryCode;

		CMDBField<TCommsDatWlanRegDomain>									iDefaultRegulatoryDomain;

	private:

		static const SRecordTypeInfo* const iRecordInfo;

	};

//

// 04/  NETWORK RECORD

//

/**

@publishedAll

@released

*/

class CCDNetworkRecord : public CCDRecordBase

	{

	public :

		/**

		@internalComponent

		*/

		CCDNetworkRecord();

		/**

		@internalComponent

		*/

		CCDNetworkRecord(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;}	

    	DATA_VTABLE

	public:

       		CMDBField<TDesC>		    iHostName;	//< Name of the host of the network

	private:

		static const SRecordTypeInfo* const iRecordInfo;

	};

//

//  05/  LOCATION RECORD

//

/**

@publishedAll

@released

*/

class CCDLocationRecord : public CCDRecordBase

	{

	public :

		// Constructors

		/**

		@internalComponent

		*/

		CCDLocationRecord();

		/**

		@internalComponent

		*/

		CCDLocationRecord(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;}  	

		DATA_VTABLE

	public:

		// MemberData

		CMDBField<TDesC>	        iIntlPrefixCode;				//< Prefix code to use for international calls.

		CMDBField<TDesC>	        iNatPrefixCode;					//< Prefix code to use for national calls.

		CMDBField<TDesC>		    iNatCode;						//< Country code.

		CMDBField<TDesC>		    iAreaCode;						//< Area code.

		CMDBField<TDesC>		    iDialOutCode;					//< Number to dial for an outside line.

		CMDBField<TDesC>	        iDisableCallWaitingCode;		//< Code to dial to disable call waiting facility.

		CMDBField<TBool>		iMobile;							//< Specifies whether the device is a mobile phone.

		CMDBField<TBool>		iUsePulseDial;						//< Specifies whether to use pulse dialling.

		CMDBField<TBool>	    iWaitForDialTone;					//< Specifies whether to wait for the dial tone.

		CMDBField<TUint32>	    iPauseAfterDialOut;					//< This specifies the length of the pause (in seconds) after using the dial-out code. In the dial string this delay is represented as a comma. The number indicates the value of that comma.

    private:

		static const SRecordTypeInfo* const iRecordInfo;

	};

//

// 06/  IAP RECORD

//

/**

@publishedAll

@released

*/

class CCDIAPRecord : public CCDRecordBase

	{

	public:

		/**

		@internalComponent

		*/

		CCDIAPRecord();

		/**

		@internalComponent

		*/

		CCDIAPRecord(TMDBElementId aElementId);

			/** 

		Gets the following information: 

		- iTypeId

		- iValType 

		- iTypeAttr

		- iTypeName           

		@return Returns a const pointer to the record containing the data - client does not need to delete this pointer after use.

		*/

        const SRecordTypeInfo* GetRecordInfo(){return iRecordInfo;}		

    	DATA_VTABLE

	public:

		// Member Data

		CMDBField<TDesC>                        iServiceType;			//< The name of a servicing table. E.g. DialOutISP.

		CMDBRecordLink<CCDServiceRecordBase>	iService;				//< Every IAP provides a specific service.  The field IAPService provides a link between the IAP and the servicing table, It tells us which record to use from the servicing table. For example, an IAP could provide the DialOutISP service.  Say IAPService = 1, this would mean the settings of first record in the DialOutISP table is provided by this particular IAP.

		CMDBField<TDesC>                        iBearerType;			//< The name of the bearer to be used for the IAP.

		CMDBRecordLink<CCDBearerRecordBase>	    iBearer;				//< The record id from the Bearer table specifying the bearer to be used with the IAP.

		CMDBRecordLink<CCDNetworkRecord>	    iNetwork;				//< The record id of the network to be used with the IAP. The IAP will connect to this network.

		CMDBField<TUint32>	                    iNetworkWeighting;		//< When there are multiple IAPs that wish to connect to the same network, this subset of IAPs is given a weighting. This determines the order of connection to that particular network. The IAP with the highest weighting will receive the first connection attempt and if that fails, the next highest IAP is attempted and so forth. This is an alternative way to make a connection if the ConnectionPreferences ranking system is not preferred.

		CMDBRecordLink<CCDLocationRecord>	    iLocation;				//< The record id specifying a location for the IAP. This field links the Location table and the IAP table together. The location determines factors such as areacode prefix dialling etc.

#ifdef SYMBIAN_NETWORKING_UMTSR5	

		CMDBField<TUint32>	                    iAppSid;   // Marks this IAP for exclusive use of a particular Application

#endif

    private:

	    static const SRecordTypeInfo* const iRecordInfo;

	};

//

// 07/  WAP ACCESS POINT RECORD

//

/**

@publishedAll

@released

*/

class CCDWAPAccessPointRecord : public CCDRecordBase

	{

	public:

		/**

		@internalComponent

		*/

		CCDWAPAccessPointRecord();

		/**

		@internalComponent

		*/