// Copyright (c) 2008-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:

// This file contains all the interfaces classes that can be implemented by

// the Licensee LTSY relating to Sim related features.

//

/**

 @file

 @publishedPartner

 @released

*/

#ifndef MLTSYDISPATCHSIMINTERFACE_H_

#define MLTSYDISPATCHSIMINTERFACE_H_

#include <ctsy/ltsy/mltsydispatchinterface.h>

#include <etelmm.h>

#include <ctsy/rmmcustomapi.h>

class MLtsyDispatchSimGetApnControlListServiceStatus : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetApnControlListServiceStatusApiId = KDispatchSimFuncUnitId + 1;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetAPNControlListServiceStatus

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimGetApnControlListServiceStatusComp()

	 *

	 * Implementation of this interface should get the current Apn Control List Service status from the LTSY.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetApnControlListServiceStatusReqL() = 0;

	}; // class MLtsyDispatchSimGetApnControlListServiceStatus

class MLtsyDispatchSimDeleteApnName : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimDeleteApnNameApiId = KDispatchSimFuncUnitId + 2;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneDeleteAPNName

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimDeleteApnNameComp()

	 *

	 * Implementation of this interface should delete the given entry from the APN control list.

	 *

	 * @param aIndex The index of the entry to delete.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleDeleteApnNameReqL(TUint32 aIndex) = 0;

	}; // class MLtsyDispatchSimDeleteApnName

class MLtsyDispatchSimEnumerateApnEntries : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimEnumerateApnEntriesApiId = KDispatchSimFuncUnitId + 3;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneEnumerateAPNEntries

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimEnumerateApnEntriesComp()

	 *

	 * Implementation of this interface should enumerate the available APN names in the Access Control list.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleEnumerateApnEntriesReqL() = 0;

	}; // class MLtsyDispatchSimEnumerateApnEntries

class MLtsyDispatchSimChangeSecurityCode : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimChangeSecurityCodeApiId = KDispatchSimFuncUnitId + 4;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneChangeSecurityCode

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimChangeSecurityCodeComp()

	 *

	 * Implementation of this interface should allow a client to change a security code.

	 *

	 * @param aSecCode The security code to be changed.

	 * @param aPasswds The old and the new values of the security code.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleChangeSecurityCodeReqL(RMobilePhone::TMobilePhoneSecurityCode aSecCode,

			   								  const RMobilePhone::TMobilePhonePasswordChangeV1& aPasswds) = 0;

	}; // class MLtsyDispatchSimChangeSecurityCode

class MLtsyDispatchSimSetFdnSetting : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimSetFdnSettingApiId = KDispatchSimFuncUnitId + 5;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetFdnSetting

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimSetFdnSettingComp()

	 *

	 * Implementation of this interface should activate or deactivate the Fixed Dialling Numbers (FDN) service

	 * PIN2 must have been verified prior to changing the Fixed Dialling Numbers setting.

	 *

	 * @param aFdnSetting The FDN setting value.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleSetFdnSettingReqL(RMobilePhone::TMobilePhoneFdnSetting aFdnSetting) = 0;

	}; // class MLtsyDispatchSimSetFdnSetting

class MLtsyDispatchSimGetCustomerServiceProfile : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetCustomerServiceProfileApiId = KDispatchSimFuncUnitId + 6;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetCustomerServiceProfile

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimGetCustomerServiceProfileComp()

	 *

	 * Implementation of this interface should retrieve the whole Customer Service Profile file from LTSY.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetCustomerServiceProfileReqL() = 0;

	}; // class MLtsyDispatchSimGetCustomerServiceProfile

class MLtsyDispatchSimGetSubscriberId : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetSubscriberIdApiId = KDispatchSimFuncUnitId + 7;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetSubscriberId

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimGetSubscriberIdComp()

	 *

	 * Implementation of this interface should get the subscriber's identity as described by its IMSI from the LTSY.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetSubscriberIdReqL() = 0;

	}; // class MLtsyDispatchSimGetSubscriberId

class MLtsyDispatchSimAppendApnName : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimAppendApnNameApiId = KDispatchSimFuncUnitId + 8;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneAppendAPNName

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimAppendApnNameComp()

	 *

	 * Implementation of this interface should append the given entry to the end of the APN control list.

	 *

	 * @param aEntry The entry to append to the APN list.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleAppendApnNameReqL(const RMobilePhone::TAPNEntryV3& aEntry) = 0;

	}; // class MLtsyDispatchSimAppendApnName

class MLtsyDispatchSimGetActiveIccApplicationType : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetActiveIccApplicationTypeApiId = KDispatchSimFuncUnitId + 9;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsySimGetICCType

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimGetActiveIccApplicationTypeComp()

	 *

	 * This handler is called by the CTSY to retrieve the current active ICC application type.

	 * Types are defined in MLtsyDispatchSimGetActiveIccApplicationType::TIccType.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	enum TIccType

	    {

	    EIccTypeSim2GGsm,

	    EIccTypeSim3G,

	    EIccTypeSimUnknown

	    };

	virtual TInt HandleGetActiveIccApplicationTypeReqL() = 0;

	}; // class MLtsyDispatchSimGetActiveIccApplicationType

class MLtsyDispatchSimSetIccMessageWaitingIndicators : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimSetIccMessageWaitingIndicatorsApiId = KDispatchSimFuncUnitId + 10;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetIccMessageWaitingIndicators

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimSetIccMessageWaitingIndicatorsComp()

	 *

	 * Implementation of this interface should set the message waiting indicators on the current ICC.

	 *

	 * @param aIndicators The message waiting indicators to set.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleSetIccMessageWaitingIndicatorsReqL(const RMobilePhone::TMobilePhoneMessageWaitingV1& aIndicators) = 0;

	}; // class MLtsyDispatchSimSetIccMessageWaitingIndicators

class MLtsyDispatchSimSetApnControlListServiceStatus : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimSetApnControlListServiceStatusApiId = KDispatchSimFuncUnitId + 11;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetAPNControlListServiceStatus

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimSetApnControlListServiceStatusComp()

	 *

	 * Implementation of this interface should set the status of the APN Control List Service.

	 *

	 * @param aStatus The service status to set.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleSetApnControlListServiceStatusReqL(RMobilePhone::TAPNControlListServiceStatus aStatus) = 0;

	}; // class MLtsyDispatchSimSetApnControlListServiceStatus

class MLtsyDispatchSimGetApnName : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetApnNameApiId = KDispatchSimFuncUnitId + 12;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetAPNname

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimGetApnNameComp()

	 *

	 * Implementation of this interface should get the APN entry from the APN list at the index specified.

	 *

	 * @param aIndex The index of the APN entry to get from LTSY.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetApnNameReqL(TUint32 aIndex) = 0;

	}; // class MLtsyDispatchSimGetApnName

class MLtsyDispatchSimSimRefreshDone : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimSimRefreshDoneApiId = KDispatchSimFuncUnitId + 13;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMmTsySimRefreshDoneIPC

	 * request from the CTSY.

	 *

	 * It is a request call that has no complete.

	 *

	 *

	 * Implementation of this interface indicates to the LTSY the SIM refresh has finished.

	 *

	 *

	 * @param aError An error code relating to the result of the refresh.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleSimRefreshDoneReqL(TInt aError) = 0;

	}; // class MLtsyDispatchSimSimRefreshDone

class MLtsyDispatchSimGetServiceTable : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetServiceTableApiId = KDispatchSimFuncUnitId + 14;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetServiceTable

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking CCtsyDispatcherCallback::CallbackSimGetServiceTableComp()

	 *

	 * Implementation of this interface should read the EFust or EFsst service tables as specified by aServiceTable.

	 *

	 * @param aServiceTable Specifies the service table to retrieve.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetServiceTableReqL(RMobilePhone::TMobilePhoneServiceTable aServiceTable) = 0;

	}; // class MLtsyDispatchSimGetServiceTable

class MLtsyDispatchSimGetIccMessageWaitingIndicators : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetIccMessageWaitingIndicatorsApiId = KDispatchSimFuncUnitId + 15;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetIccMessageWaitingIndicators

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking CCtsyDispatcherCallback::CallbackSimGetIccMessageWaitingIndicatorsComp()

	 *

	 * Implementation of this interface should get the ICC message waiting indicators from the (U)SIM field EFmwis.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetIccMessageWaitingIndicatorsReqL() = 0;

	}; // class MLtsyDispatcSimGetIccMessageWaitingIndicators

class MLtsyDispatchSimSimLockActivate : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimSimLockActivateApiId = KDispatchSimFuncUnitId + 16;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the ECustomSimLockActivateIPC

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimSimLockActivateComp()

	 * 

	 * Implementation of this interface should send a SIM Lock Activation request.

	 *

	 * @param aPassword The password used for the SIM Lock activation.

	 * @param aLockNumber The lock number that defines SIM Lock types.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleSimLockActivateReqL(const TDesC& aPassword, RMmCustomAPI::TLockNumber aLockNumber) = 0;

	}; // class MLtsyDispatchSimSimLockActivate

class MLtsyDispatchSimSimLockDeActivate : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimSimLockDeActivateApiId = KDispatchSimFuncUnitId + 17;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the ECustomSimLockDeActivateIPC

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimSimLockDeActivateComp()

	 * 

	 * Implementation of this interface should send a SIM Lock Deactivation request. 

	 * 

	 * @param aPassword The password used for the SIM Lock deactivation.

	 * @param aLockNumber The lock number that defines SIM Lock types.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleSimLockDeActivateReqL(const TDesC& aPassword, RMmCustomAPI::TLockNumber aLockNumber) = 0;

	}; // class MLtsyDispatchSimSimLockDeActivate

class MLtsyDispatchSimGetAnswerToReset : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSimGetAnswerToResetApiId = KDispatchSimFuncUnitId + 18;

	/**

	 * The CTSY Dispatcher shall invoke this function on receiving the ECustomGetATRIPC

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSimGetAnswerToResetComp()

	 * 

	 * Implementation of this interface should retrieve the answer to reset. 

	 *

	 * @param aAnswerToReset The answer to reset information which contains details of the request.

	 *

	 * @return KErrNone on success, otherwise another error code indicating the

	 * failure.

	 */

	virtual TInt HandleGetAnswerToResetReqL(const TDesC8& aAnswerToReset) = 0;

	}; // class MLtsyDispatchSimGetAnswerToReset