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

//

/**

 @file

 @internalAll 

*/

#ifndef MLTSYDISPATCHSATINTERFACE_H_

#define MLTSYDISPATCHSATINTERFACE_H_

#include <ctsy/ltsy/mltsydispatchinterface.h>

namespace DispatcherSat

	{

	/**

	 * This namespace contains all types relating to the SAT dispatcher.

	 */

	/**

	 * Enum containing the SS status

	 */

	enum TSsStatus

		{

		ENotBusy,

		ESsBusy,

		EUssdBusy

		};

	}

class MLtsyDispatchSatSmsDeliverReport : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatSmsDeliverReportApiId = KDispatchSatFuncUnitId + 1;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * 

	 * It is a request call that does not have an associated complete callback.

	 *

	 * Implementation of this interface should handle the requested SMS DELIVER REPORT Tpdu as

	 * a result of the CCtsyDispatcherCallback::CallbackSatCreateSmsDeliverReportInd()

	 * 

	 * An SMS DELIVER REPORT TPDU is carried as a RP User Data element within an RP ERROR PDU 

	 * and is part of the negative acknowledgement to an SMS DELIVER or SMS STATUS REPORT.

	 * 

	 * An SMS DELIVER REPORT TPDU is also carried as a RP User Data element within an RP ACK PDU 

	 * and is part of a positive acknowledgement to a SMS DELIVER or SMS STATUS REPORT.

	 * 

	 *

	 * @param aSmsDeliverReportTpdu The SMS-DELIVER-REPORT TPDU element to be contained in a 

	 * RP-ERROR-PDU (negative acknowledgement) or RP-ACK-PDU (a positive acknowledgement) to a

	 * SMS DELIVER or SMS STATUS REPORT

	 *

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

	 * failure.

	 */

	virtual TInt HandleSmsDeliverReportReqL(const TDesC8& aSmsDeliverReportTpdu) = 0;

	}; // class MLtsyDispatchSatSmsDeliverReport

class MLtsyDispatchSatGetImageInstance : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetImageInstanceApiId = KDispatchSatFuncUnitId + 2;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetImageInstanceComp()

	 * 

	 * Implementation of this interface should retrieve an icon's image data from the UICC 

	 * designated by aEfImgRecordNumber & aInstanceNumberInEfImgRecord

	 *

	 * @param aEfImgRecordNumber 			The record number of the icons EF(img) record for the 

	 * 										icon image instance being retrieved. 

	 * @param aInstanceNumberInEfImgRecord 	The record number of the icon instance, in the icons EF(img) record

	 * 										for the icon image instance being retrieved. 

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetImageInstanceReqL(TUint8 aEfImgRecordNumber, TUint8 aInstanceNumberInEfImgRecord) = 0;

	}; // class MLtsyDispatchSatGetImageInstance

class MLtsyDispatchSatGetIconData : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetIconDataApiId = KDispatchSatFuncUnitId + 3;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetIconDataComp()

	 * 

	 * Implementation of this interface should retrieve an icon's EF record from the UICC based

	 * on the record number (see ETSI TS 131 102 Under EFIMG (Image) & Files of USIM)

	 *

	 * @param aEfImgRecordNumber 	EF(img) record number of the icon to retrieve 

	 * @param aSimFilePath 			The full file path to the EF(Img) 

	 * 								Bytes 	0-1 MF 			(0x3F00)

	 * 								Bytes	2-3 DF(Telecom) (0x7F10) 

	 * 								Bytes	4-5 DF(Graphics)(0x5F50)

	 * 								Bytes	6-7 EF(Ef(Img)) 	(0x4F20)

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetIconDataReqL(TUint8 aEfImgRecordNumber, const TDesC8& aSimFilePath) = 0;

	}; // class MLtsyDispatchSatGetIconData

class MLtsyDispatchSatGetClut : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetClutApiId = KDispatchSatFuncUnitId + 4;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetClutComp()

	 * 

	 * Implementation of this interface should retrieve the CLUT (Colour Lookup Table) for an image instance 

	 * designated by aEfImgRecordNumber & aInstanceNumberInEfImgRecord

	 *

	 * @param aEfImgRecordNumber 			The record number of the icons EF(Img) record for the 

	 * 										CLUT being retrieved.

	 * @param aInstanceNumberInEfImgRecord 	The record number of the icon instance, in the icons EF(Img) record

	 * 										for the CLUT being retrieved.

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetClutReqL(TUint8 aEfImgRecordNumber, TUint8 aInstanceNumberInEfImgRecord) = 0;

	}; // class MLtsyDispatchSatGetClut

class MLtsyDispatchSatGetDefaultBearerCapability : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetDefaultBearerCapabilityApiId = KDispatchSatFuncUnitId + 5;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetDefaultBearerCapabilityComp()

	 * 

	 * Implementation of this interface should retrieve the current default bearer capability configuration.

	 * 

	 * The default bearer capability configuration (coding as defined by the access technologies) will be used 

	 * by the CTSY when creating a Call Control ENVELOPE (the capability configuration parameters) if a zero length 

	 * capability parameters is passed when creating the Envelope. 

	 * See "ETSI TS 102 223" "Structure of ENVELOPE (CALL CONTROL)"

	 * 

	 * @see MLtsyDispatchSatCallAndSmsControlEnvelope::HandleCallAndSmsControlEnvelopeReqL()

	 * @see CCtsyDispatcherCallback::CallbackSatCallControlEnvelopeResponseInd()

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetDefaultBearerCapabilityReqL() = 0;

	}; // class MLtsyDispatchSatGetDefaultBearerCapability

class MLtsyDispatchSatGetSmsPpDownloadSupported : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetSmsPpDownloadSupportedApiId = KDispatchSatFuncUnitId + 6;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetSmsPpDownloadSupportedComp()

	 * 

	 * Implementation of this interface should retrieve if the service 

	 * "data download via SMS Point-to-point" is allocated and activated in the SIM Service Table

	 * and return the result via CCtsyDispatcherCallback::CallbackSatGetSmsPpDownloadSupportedComp()

	 * 

	 * @see 3GPP TS 11.14 section 7.1

	 * @see 3GPP TS 11.11 section 11.6.12

	 *

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetSmsPpDownloadSupportedReqL() = 0;

	}; // class MLtsyDispatchSatGetSmsPpDownloadSupported

class MLtsyDispatchSatGetSmsControlActivated : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetSmsControlActivatedApiId = KDispatchSatFuncUnitId + 7;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetSmsControlActivatedComp()

	 * 

	 * Implementation of this interface should retrieve the current activation state of 

	 * MO-SMS Control by USIM (Service n°31 in EFust).

	 * 

	 * @see 3GPP TS 11.11 section 11.6.16

	 * @see 3GPP TS 31.102 section 4.2.8

	 * 

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetSmsControlActivatedReqL() = 0;

	}; // class MLtsyDispatchSatGetSmsControlActivated

class MLtsyDispatchSatGetAccessTechnology : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatGetAccessTechnologyApiId = KDispatchSatFuncUnitId + 8;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatGetAccessTechnologyComp()

	 * 

	 * Implementation of this interface should cause the current access technology to be

	 * sent up to the CTSY via the CallbackSatGetAccessTechnologyComp() callback.

	 * 

	 * This request is generated when a LOCAL INFORMATION (access technology)

	 * proactive command is received from UICC.

	 * 

	 *

	 *

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

	 * failure.

	 */

	virtual TInt HandleGetAccessTechnologyReqL() = 0;

	}; // class MLtsyDispatchSatGetAccessTechnology

class MLtsyDispatchSatCellBroadcastEnvelope : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatCellBroadcastEnvelopeApiId = KDispatchSatFuncUnitId + 9;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that does not have an associated complete callback.

	 * 

	 * 

	 * Implementation of this interface should hanldle Cell Broadcast Envelope commands.

	 * This ENVELOPE is created as a result of a CallbackSatCreateCellBroadcastEnvelopeInd() call.

	 *

	 * Once the ME receives a new Cell Broadcast message and the service, if "data download via SMS-CB" is 

	 * allocated and activated in the SIM Service Table and if the message identifier of the Cell Broadcast 

	 * is contained within the message identifiers of the EF(CBMID), the the cell broadcast page is passed 

	 * to the SIM using the ENVELOPE (CELL BROADCAST DOWNLOAD) command.

	 * 

	 * See "3GPP TS 11.14" Under "Cell Broadcast data download"

	 * 

	 *

	 * @param aEnvelope BER-TLV encoded data containing an (CELL BROADCAST DOWNLOAD) ENVELOPE command. 

	 *

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

	 * failure.

	 */

	virtual TInt HandleCellBroadcastEnvelopeReqL(const TDesC8& aEnvelope) = 0;

	}; // class MLtsyDispatchSatCellBroadcastEnvelope

class MLtsyDispatchSatTimingAdvance : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatTimingAdvanceApiId = KDispatchSatFuncUnitId + 10;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatTimingAdvanceComp()

	 * 

	 * Implementation of this interface should ascertain the Timing Advance measurement from the GSM/3G

	 * protocol. It can then be provided to the SIM application in response to a PROVIDE LOCAL INFO 

	 * proactive command.

	 * 

	 *

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

	 * failure.

	 */

	virtual TInt HandleTimingAdvanceReqL() = 0;

	}; // class MLtsyDispatchSatTimingAdvance

class MLtsyDispatchSatSmControlResponseData : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatSmControlResponseDataApiId = KDispatchSatFuncUnitId + 11;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that does not have an associated complete callback.

	 * 

	 * Implementation of this interface should handle the parsed Mo Short Message Control response TLV data.

	 * 

	 * As a result of the ENVELOPE (MO SHORT MESSAGE CONTROL) command sent to the SIM, the SIM will respond

	 * with a response TLV, this is can be passed to the LTSY via the 

	 * CCtsyDispatcherCallback::CallbackSatSmControlEnvelopeResponseInd().

	 * The CTSY parses this TLV, completes the RSat::NotifySmControlRequest() on the client side and passes

	 * down the parsed data to the LTSY via this handler.

	 * 

	 * See "3GPP 11.14 - MO Short Message Control by SIM"

	 *

	 * @param aResult MO short message control result the SIM gives to the ME concerning whether to 

	 * allow, bar or modify the proposed short message, encoded as defined in "3GPP TS 11.10-4, 27.22.8 MO SHORT MESSAGE CONTROL BY SIM" 

	 * @param aRpDestinationAddress RP Destination Address of the Service Center to which the ME is proposing to send the short message.

	 * If the address data is not present (zero length), then assume the RP Destination Address of the Service Center is not to be modified. 

	 * @param aTpDestinationAddress TP Destination Address to which the ME is proposing to send the short message.

	 * If the address data is not present (zero length), then assume the TP Destination Address is not to be modified. 

	 *

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

	 * failure.

	 */

	virtual TInt HandleSmControlResponseDataReqL(

			TUint8 aResult, const TDesC8& aRpDestinationAddress, const TDesC8& aTpDestinationAddress) = 0;

	}; // class MLtsyDispatchSatSmControlResponseData

class MLtsyDispatchSatProvideLocationInfo : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatProvideLocationInfoApiId = KDispatchSatFuncUnitId + 12;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatProvideLocationInfoComp()

	 * 

	 * Implementation of this interface should cause location information data to be provided, which can then be used

	 * for Call/SS/USSD Control.

	 * 

	 * See "3GPP TS 11.14" section 9.1.1

	 * 

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

	 * failure.

	 */

	virtual TInt HandleProvideLocationInfoReqL() = 0;

	}; // class MLtsyDispatchSatProvideLocationInfo

class MLtsyDispatchSatSetPollingInterval : public MLtsyDispatchInterface

	{

public:

	static const TInt KLtsyDispatchSatSetPollingIntervalApiId = KDispatchSatFuncUnitId + 13;

	/**

	 * This API is optional and should only be used if the licensee wishes to including the

	 * Dispatcher beneath their own SIM ATK TSY.

	 * 

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

	 * request from the CTSY.

	 * 

	 * It is a request call that is completed by invoking

	 * CCtsyDispatcherCallback::CallbackSatSetPollingIntervalComp()

	 * 

	 * Implementation of this interface should attempt to update the polling interval in the LTSY.

	 * 

	 * A Proactive command from the UICC indicates the poll interval it requests from then onwards.

	 * The CTSY then notifies the LTSY the maximum poll interval it should use in seconds 

	 * (via a HandleSetPollingIntervalReqL()), the LTSY completes the request (via a CallbackSatSetPollingIntervalComp())

	 * indicating the interval that will be used. If successful the CTSY then sends a terminal response, in response 

	 * to the original proactive command. If unsuccessful and polling is currently off a terminal response is sent

	 * with a result of Unable To Process Command, in the case where polling is currently on the request to the LTSY is 

	 * re-attempted with a legacy polling interval of 25 seconds.

	 * 

	 * The polling interval ranges from a minimum of 5 and maximum of 255 seconds, 

	 * a polling interval of zero (0) indiates that polling should be turned off.

	 * 

	 * See "ETSI TS 102 223" "POLL INTERVAL"

	 *

	 * @param aPollingInterval The polling interval in seconds indicating how often the 

	 * terminal sends STATUS commands related to Proactive Polling 

	 * (zero indicates Polling should be turned off) 

	 *

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

	 * failure.