// 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 Phone related features.

//

/**

 @file

 @publishedPartner

 @released

*/

#ifndef MLTSYDISPATCHPHONEINTERFACE_H_

#define MLTSYDISPATCHPHONEINTERFACE_H_

#include <ctsy/ltsy/mltsydispatchinterface.h>

#include <etelmm.h>

#include <ctsy/rmmcustomapi.h>

class MLtsyDispatchPhoneBootNotifyModemStatusReady : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneBootNotifyModemStatusReadyApiId = KDispatchPhoneFuncUnitId+1;

	/**

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

	 * request from the CTSY.

	 *

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

	 *

	 * Implementation of this interface should indicate when the

	 * Modem is ready for requests made from the CTSY.

	 *

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

	 * failure.

	 */

	virtual TInt HandleBootNotifyModemStatusReadyReqL() = 0;

	}; // class MLtsyDispatchPhoneBootNotifyModemStatusReady

class MLtsyDispatchPhoneBootNotifySimStatusReady : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneBootNotifySimStatusReadyApiId = KDispatchPhoneFuncUnitId+2;

	/**

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

	 * request from the CTSY.

	 *

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

	 *

	 * Implementation of this interface should indicate when the SIM is ready

	 * for requests made from the CTSY.

	 * For example, any caching of data has been completed.

	 *

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

	 * failure.

	 */

	virtual TInt HandleBootNotifySimStatusReadyReqL() = 0;

	}; // class MLtsyDispatchPhoneBootNotifySimStatusReady

class MLtsyDispatchPhoneGetFdnStatus : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetFdnStatusApiId = KDispatchPhoneFuncUnitId + 3;

	/**

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

	 * request from the CTSY.

	 *

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

	 *

	 * Implementation of this interface should get the current FDN status.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetFdnStatusReqL() = 0;

	}; // class MLtsyDispatchPhoneGetFdnStatus

class MLtsyDispatchPhoneGetHomeNetwork : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetHomeNetworkApiId = KDispatchPhoneFuncUnitId + 4;

	/**

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

	 * request from the CTSY.

	 *

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

	 *

	 * Implementation of this interface should get the current home network.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetHomeNetworkReqL() = 0;

	}; // class MLtsyDispatchPhoneGetHomeNetwork

class MLtsyDispatchPhoneGetNetworkRegistrationStatus : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetNetworkRegistrationStatusApiId = KDispatchPhoneFuncUnitId + 5;

	/**

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

	 * request from the CTSY.

	 *

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

	 *

	 * Implementation of this interface should get the current network registration status.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetNetworkRegistrationStatusReqL() = 0;

	}; // class MLtsyDispatchPhoneGetNetworkRegistrationStatus

class MLtsyDispatchPhoneSimRefreshRegister : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneSimRefreshRegisterApiId = KDispatchPhoneFuncUnitId + 6;

	/**

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

	 * request from the CTSY.

	 *

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

	 *

	 * Implementation of this interface should return whether registering for refresh indications on a list of SIM files was successful.

	 * Note: When the LTSY needs to notify the CTSY of a refresh CCtsyDispatcherCallback::CallbackPhoneSimRefreshNowInd() should be invoked.

	 *

	 * @param aFilesToRegister  Bitmask containing list of files to register for refresh indications.

	 *                           The list of possible files is specified in TCacheFileTypes.

	 *

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

	 * failure.

	 */

	virtual TInt HandleSimRefreshRegisterReqL(TUint16 aFilesToRegister) = 0;

	}; // class MLtsyDispatchPhoneSimRefreshRegister

class MLtsyDispatchPhoneGetServiceProviderName : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneGetServiceProviderNameApiId = KDispatchPhoneFuncUnitId + 7;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneGetServiceProviderNameComp()

	 *

	 * The service provider information to be returned is in the form RMobilePhone::TMobilePhoneServiceProviderNameV2.

	 *

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetServiceProviderNameReqL() = 0;

	}; // class MLtsyDispatchPhoneGetServiceProviderName

class MLtsyDispatchPhoneGetPhoneId : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneGetPhoneIdApiId = KDispatchPhoneFuncUnitId + 8;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneGetPhoneIdComp()

	 *

	 * Implementation of this interface should get the phone's identity as described by the

	 * fields in RMobilePhone::TMobilePhoneIdentityV1.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetPhoneIdReqL() = 0;

	}; // class MLtsyDispatchPhoneGetPhoneId

class MLtsyDispatchPhoneGetDetectedNetworks : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneGetDetectedNetworksApiId = KDispatchPhoneFuncUnitId + 9;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneGetDetectedNetworksComp()

	 *

	 * Implementation of this interface should get the current detected networks.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetDetectedNetworksReqL() = 0;

	}; // class MLtsyDispatchPhoneGetDetectedNetworks

class MLtsyDispatchPhoneGetDetectedNetworksCancel : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneGetDetectedNetworksCancelApiId = KDispatchPhoneFuncUnitId + 10;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneGetDetectedNetworksCancelComp()

	 *

	 * Implementation of this interface should cancel a pending retrieval of the detected networks.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetDetectedNetworksCancelReqL() = 0;

	}; // class MLtsyDispatchPhoneGetDetectedNetworksCancel

class MLtsyDispatchPhoneSelectNetwork : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneSelectNetworkApiId = KDispatchPhoneFuncUnitId + 11;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneSelectNetworkComp()

	 *

	 * Implementation of this interface should attempt a network selection.

	 *

	 * @param aIsManual Specifies whether phone should use a manual or automatic network selection method.

	 * @param aNetworkManualSelection If aIsManual==ETrue, then this parameter contain the user's manually selected network.

	 *

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

	 * failure.

	 */

	virtual TInt HandleSelectNetworkReqL(TBool aIsManual, const RMobilePhone::TMobilePhoneNetworkManualSelection& aNetworkManualSelection) = 0;

	}; // class MLtsyDispatchPhoneSelectNetwork

class MLtsyDispatchPhoneSelectNetworkCancel : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneSelectNetworkCancelApiId = KDispatchPhoneFuncUnitId + 12;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneSelectNetworkCancelComp()

	 *

	 * Implementation of this interface should cancel a pending network selection.

	 *

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

	 * failure.

	 */

	virtual TInt HandleSelectNetworkCancelReqL() = 0;

	}; // class MLtsyDispatchPhoneSelectNetworkCancel

class MLtsyDispatchPhoneSetNetworkSelectionSetting : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchPhoneSetNetworkSelectionSettingApiId = KDispatchPhoneFuncUnitId + 13;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneSetNetworkSelectionSettingComp()

	 *

	 * Implementation of this interface should set the new network selection.

	 * Note: 	The completion of this will also invoke the network selection change

	 * 			notifier in the CTSY (EMobilePhoneNotifyNetworkSelectionSettingChange).

	 *

	 * @param aPhoneNetworkSelection The new network selection setting.

	 *

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

	 * failure.

	 */

	virtual TInt HandleSetNetworkSelectionSettingReqL(const RMobilePhone::TMobilePhoneNetworkSelectionV1& aPhoneNetworkSelection) = 0;

	}; // class MLtsyDispatchPhoneSetNetworkSelectionSetting

class MLtsyDispatchPhoneGetCurrentNetworkInfo : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetCurrentNetworkInfoApiId = KDispatchPhoneFuncUnitId + 14;

	/**

	 * The CTSY Dispatcher shall invoke this function after a NotifyModemReadyReceived event occurs,

	 * normally during phone boot-up. It is an internal call.

	 *

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

	 *

	 * Implementation of this interface should get the current network information.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetCurrentNetworkInfoReqL() = 0;

	}; // class MLtsyDispatchPhoneGetCurrentNetworkInfo

class MLtsyDispatchPhoneGetNetworkMode : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetNetworkModeApiId = KDispatchPhoneFuncUnitId + 15;

	/**

	 * The CTSY Dispatcher shall invoke this function after a NotifyModemReadyReceived event occurs,

	 * normally during phone boot-up. It is an internal call.

	 *

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

	 *

	 * Implementation of this interface should get the current network information.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetNetworkModeReqL() = 0;

	}; // class MLtsyDispatchPhoneGetNetworkMode

class MLtsyDispatchPhoneGetNitzInfo : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetNitzInfoApiId = KDispatchPhoneFuncUnitId + 16;

	/**

	 * The CTSY Dispatcher shall invoke this function after a NotifyModemReadyReceived event occurs,

	 * normally during phone boot-up. It is an internal call.

	 *

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

	 *

	 * Implementation of this interface should get the current network NITZ information.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetNitzInfoReqL() = 0;

	}; // class MLtsyDispatchPhoneGetNitzInfo

class MLtsyDispatchPhoneGetSignalStrength : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetSignalStrengthApiId = KDispatchPhoneFuncUnitId + 17;

	/**

	 * The CTSY Dispatcher shall invoke this function after a NotifyModemReadyReceived event occurs,

	 * normally during phone boot-up. It is an internal call.

	 *

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

	 *

	 * Implementation of this interface should get the current network signal strength information.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetSignalStrengthReqL() = 0;

	}; // class MLtsyDispatchPhoneGetSignalStrength

class MLtsyDispatchPhoneGetBatteryInfo : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneGetBatteryInfoApiId = KDispatchPhoneFuncUnitId + 18;

	/**

	 * The CTSY Dispatcher shall invoke this function after a NotifyModemReadyReceived event occurs,

	 * normally during phone boot-up. It is an internal call.

	 *

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

	 *

	 * Implementation of this interface should get the current battery information.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetBatteryInfoReqL() = 0;

	}; // class MLtsyDispatchPhoneGetBatteryInfo

class MLtsyDispatchPhoneNspsWakeup : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneNspsWakeupApiId = KDispatchPhoneFuncUnitId + 19;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneNspsWakeupComp().

	 *

	 * Implementation of this interface should wake the phone from a NSPS (No Service Power Save) state.

	 *

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

	 * failure.

	 */

	virtual TInt HandleNspsWakeupReqL() = 0;

	}; // class MLtsyDispatchPhoneNspsWakeup

class MLtsyDispatchPhoneSetSystemNetworkMode : public MLtsyDispatchInterface

	{

public:

    static const TInt KLtsyDispatchPhoneSetSystemNetworkModeApiId = KDispatchPhoneFuncUnitId + 20;

	/**

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

	 * request from the CTSY.

	 *

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackPhoneSetSystemNetworkModeComp().

	 *

	 * Implementation of this interface should set the system network mode.

	 *

	 * @param aMode The new mode to set the system network to.