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

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

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

    15 // the Licensee LTSY relating to SupplementaryServices related features.

    16 //

    17 

    18 

    19 

    20 

    21 /**

    22  @file

    23  @internalAll 

    24 */

    25 

    26 

    27 #ifndef MLTSYDISPATCHSUPPLEMENTARYSERVICESINTERFACE_H_

    28 #define MLTSYDISPATCHSUPPLEMENTARYSERVICESINTERFACE_H_

    29 

    30 #include <ctsy/ltsy/mltsydispatchinterface.h>

    31 #include <etelmm.h>

    32 

    33 

    34 class MLtsyDispatchSupplementaryServicesSendNetworkServiceRequestNoFdnCheck : public MLtsyDispatchInterface

    35 	{

    36 public:

    37 

    38 	static const TInt KLtsyDispatchSupplementaryServicesSendNetworkServiceRequestNoFdnCheckApiId = KDispatchSupplementaryServicesFuncUnitId + 1;

    39 

    40 	/**

    41 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSendNetworkServiceRequestNoFdnCheck

    42 	 * request from the CTSY.

    43 	 *

    44 	 * It is a request call that is completed by invoking

    45 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSendNetworkServiceRequestNoFdnCheckComp()

    46 	 * 

    47 	 * Implementation of this interface should send the request to the network without FDN check.

    48 	 *

    49 	 *

    50 	 * @param aRequest The supplementary services string that was entered by the user and need to be send to the network.

    51 	 *

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

    53 	 * failure.

    54 	 */

    55 	virtual TInt HandleSendNetworkServiceRequestNoFdnCheckReqL(const TDesC& aRequest) = 0;

    56 

    57 	}; // class MLtsyDispatchSupplementaryServicesSendNetworkServiceRequestNoFdnCheck

    58 

    59 

    60 

    61 class MLtsyDispatchSupplementaryServicesGetCallWaitingStatus : public MLtsyDispatchInterface

    62 	{

    63 public:

    64 

    65 	static const TInt KLtsyDispatchSupplementaryServicesGetCallWaitingStatusApiId = KDispatchSupplementaryServicesFuncUnitId + 2;

    66 

    67 	/**

    68 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetWaitingStatusPhase1

    69 	 * request from the CTSY.

    70 	 *

    71 	 * It is a request call that is completed by invoking

    72 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesGetCallWaitingStatusComp()

    73 	 *

    74 	 * Implementation of this interface should get the call waiting list.

    75 	 *

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

    77 	 * failure.

    78 	 */

    79 	virtual TInt HandleGetCallWaitingStatusReqL() = 0;

    80 

    81 	}; // class MLtsyDispatchSupplementaryServicesGetCallWaitingStatus

    82 

    83 

    84 

    85 class MLtsyDispatchSupplementaryServicesSendNetworkServiceRequest : public MLtsyDispatchInterface

    86 	{

    87 public:

    88 

    89 	static const TInt KLtsyDispatchSupplementaryServicesSendNetworkServiceRequestApiId = KDispatchSupplementaryServicesFuncUnitId + 3;

    90 

    91 	/**

    92 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSendNetworkServiceRequest

    93 	 * request from the CTSY.

    94 	 *

    95 	 * It is a request call that is completed by invoking

    96 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSendNetworkServiceRequestComp()

    97 	 * 

    98 	 * Implementation of this interface should send the request to the network after FDN check.

    99 	 *

   100 	 *

   101 	 * @param aRequest The supplementary services string that was entered by the user and need to be send to the network.

   102 	 *

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

   104 	 * failure.

   105 	 */

   106 	virtual TInt HandleSendNetworkServiceRequestReqL(const TDesC& aRequest) = 0;

   107 

   108 	}; // class MLtsyDispatchSupplementaryServicesSendNetworkServiceRequest

   109 

   110 

   111 

   112 class MLtsyDispatchSupplementaryServicesGetCallBarringStatus : public MLtsyDispatchInterface

   113 	{

   114 public:

   115 

   116 	static const TInt KLtsyDispatchSupplementaryServicesGetCallBarringStatusApiId = KDispatchSupplementaryServicesFuncUnitId + 4;

   117 

   118 	/**

   119 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetBarringStatusPhase1

   120 	 * request from the CTSY.

   121 	 *

   122 	 * It is a request call that is completed by invoking

   123 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesGetCallBarringStatusComp()

   124 	 * 

   125 	 * Implementation of this interface should get the call barring list.

   126 	 *

   127 	 *

   128 	 * @param aCondition The barring conditions to interrogate.

   129 	 *

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

   131 	 * failure.

   132 	 */

   133 	virtual TInt HandleGetCallBarringStatusReqL(RMobilePhone::TMobilePhoneCBCondition aCondition) = 0;

   134 

   135 	}; // class MLtsyDispatchSupplementaryServicesGetCallBarringStatus

   136 

   137 

   138 

   139 class MLtsyDispatchSupplementaryServicesSetCallBarringStatus : public MLtsyDispatchInterface

   140 	{

   141 public:

   142 

   143 	static const TInt KLtsyDispatchSupplementaryServicesSetCallBarringStatusApiId = KDispatchSupplementaryServicesFuncUnitId + 5;

   144 

   145 	/**

   146 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetCallBarringStatus

   147 	 * request from the CTSY.

   148 	 *

   149 	 * It is a request call that is completed by invoking

   150 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSetCallBarringStatusComp()

   151 	 * 

   152 	 * Implementation of this interface should set the call barring status for a call barring condition.

   153 	 *

   154 	 *

   155 	 * @param aCondition The call barring condition to set.

   156 	 * @param aAction The call barring action.

   157 	 * @param aGroup The call barring service group.

   158 	 * @param aPassword The password of the call barring service.

   159 	 *

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

   161 	 * failure.

   162 	 */

   163 	virtual TInt HandleSetCallBarringStatusReqL(RMobilePhone::TMobilePhoneCBCondition aCondition,

   164         RMobilePhone::TMobilePhoneServiceAction aAction,

   165         RMobilePhone::TMobileService aGroup,

   166         const TDesC& aPassword) = 0;

   167 

   168 	}; // class MLtsyDispatchSupplementaryServicesSetCallBarringStatus

   169 

   170 

   171 

   172 class MLtsyDispatchSupplementaryServicesSetCallForwardingStatus : public MLtsyDispatchInterface

   173 	{

   174 public:

   175 

   176 	static const TInt KLtsyDispatchSupplementaryServicesSetCallForwardingStatusApiId = KDispatchSupplementaryServicesFuncUnitId + 6;

   177 

   178 	/**

   179 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetCallForwardingStatus

   180 	 * request from the CTSY.

   181 	 *

   182 	 * It is a request call that is completed by invoking

   183 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSetCallForwardingStatusComp()

   184 	 * 

   185 	 * Implementation of this interface should sets a new call forwarding status and/or registered 

   186 	 * information for the call forwarding condition.

   187 	 *

   188 	 *

   189 	 * @param aCondition The condition of the new call forwarding setting.

   190 	 * @param aServiceGroup The basic service group to apply the CF status change to.

   191 	 * @param aAction The action to take.

   192 	 * @param aNumber The forwarding number.

   193 	 * @param aTimeout The time out when aCondition is ECallForwardingNoReply.

   194 	 *

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

   196 	 * failure.

   197 	 */

   198 	virtual TInt HandleSetCallForwardingStatusReqL(RMobilePhone::TMobilePhoneCFCondition aCondition,

   199 			RMobilePhone::TMobileService aServiceGroup,

   200 			RMobilePhone::TMobilePhoneServiceAction aAction,

   201 			const TDesC& aNumber,

   202 			TInt aTimeout) = 0;

   203 

   204 	}; // class MLtsyDispatchSupplementaryServicesSetCallForwardingStatus

   205 

   206 

   207 

   208 class MLtsyDispatchSupplementaryServicesSetCallWaitingStatus : public MLtsyDispatchInterface

   209 	{

   210 public:

   211 

   212 	static const TInt KLtsyDispatchSupplementaryServicesSetCallWaitingStatusApiId = KDispatchSupplementaryServicesFuncUnitId + 7;

   213 

   214 	/**

   215 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetCallWaitingStatus

   216 	 * request from the CTSY.

   217 	 *

   218 	 * It is a request call that is completed by invoking

   219 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSetCallWaitingStatusComp()

   220 	 * 

   221 	 * Implementation of this interface should set the call waiting status.

   222 	 *

   223 	 *

   224 	 * @param aServiceGroup The service group to change.

   225 	 * @param aAction The action to do with that service group.

   226 	 *

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

   228 	 * failure.

   229 	 */

   230 	virtual TInt HandleSetCallWaitingStatusReqL(RMobilePhone::TMobileService aServiceGroup, RMobilePhone::TMobilePhoneServiceAction aAction) = 0;

   231 

   232 	}; // class MLtsyDispatchSupplementaryServicesSetCallWaitingStatus

   233 

   234 

   235 

   236 class MLtsyDispatchSupplementaryServicesSetSsPassword : public MLtsyDispatchInterface

   237 	{

   238 public:

   239 

   240 	static const TInt KLtsyDispatchSupplementaryServicesSetSsPasswordApiId = KDispatchSupplementaryServicesFuncUnitId + 8;

   241 

   242 	enum TServiceType

   243 		{

   244 		EAllSupplementaryServices = 0,

   245 		ECallBarring = 330

   246 		};

   247 	

   248 	/**

   249 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneSetSSPassword

   250 	 * request from the CTSY.

   251 	 *

   252 	 * It is a request call that is completed by invoking

   253 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSetSsPasswordComp()

   254 	 * 

   255 	 * Implementation of this interface should set the password of the call barring or common Supplementary Services password.

   256 	 *

   257 	 *

   258 	 * @param aOldPassword The old password.

   259 	 * @param aNewPassword The new password.

   260 	 * @param aService The service.

   261 	 *

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

   263 	 * failure.

   264 	 */

   265 	virtual TInt HandleSetSsPasswordReqL(const TDesC& aOldPassword,

   266 			const TDesC& aNewPassword,

   267 			TServiceType aService) = 0;

   268 

   269 	}; // class MLtsyDispatchSupplementaryServicesSetSsPassword

   270 

   271 

   272 

   273 class MLtsyDispatchSupplementaryServicesGetCallForwardingStatus : public MLtsyDispatchInterface

   274 	{

   275 public:

   276 

   277 	static const TInt KLtsyDispatchSupplementaryServicesGetCallForwardingStatusApiId = KDispatchSupplementaryServicesFuncUnitId + 9;

   278 

   279 	/**

   280 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobilePhoneGetCallForwardingStatusPhase1

   281 	 * request from the CTSY.

   282 	 *

   283 	 * It is a request call that is completed by invoking

   284 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesGetCallForwardingStatusComp()

   285 	 * 

   286 	 * Implementation of this interface should get the call forwarding list.

   287 	 *

   288 	 * @param aCondition The call forwarding condition.

   289 	 * @param aService The service group.

   290 	 *

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

   292 	 * failure.

   293 	 */

   294 	virtual TInt HandleGetCallForwardingStatusReqL(RMobilePhone::TMobilePhoneCFCondition aCondition, 

   295 			RMobilePhone::TMobileService aService) = 0;

   296 

   297 	}; // class MLtsyDispatchSupplementaryServicesGetCallForwardingStatus

   298 

   299 

   300 

   301 class MLtsyDispatchSupplementaryServicesSendUssdMessage : public MLtsyDispatchInterface

   302 	{

   303 public:

   304 

   305 	static const TInt KLtsyDispatchSupplementaryServicesSendUssdMessageApiId = KDispatchSupplementaryServicesFuncUnitId + 10;

   306 

   307 	/**

   308 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobileUssdMessagingSendMessage

   309 	 * request from the CTSY.

   310 	 *

   311 	 * It is a request call that is completed by invoking

   312 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSendUssdMessageComp()

   313 	 * 

   314 	 * Implementation of this interface should send an USSD message to the network.

   315 	 *

   316 	 *

   317 	 * @param aData The actual data to send in the message.

   318 	 * @param aDcs The data coding scheme of the message.

   319 	 * @param aFormat The message format.

   320 	 * @param aType The message type (RMobileUssdMessaging::EUssdMORequest, RMobileUssdMessaging::EUssdMOReply 

   321 	 * or RMobileUssdMessaging::EUssdMOAcknowledgement).

   322 	 *

   323 	 * @return KErrNone on success, KErrGsmSSUssdBusy if the latest USSD session was not yet released, 

   324 	 * otherwise another error code indicating the failure.

   325 	 */

   326 	virtual TInt HandleSendUssdMessageReqL(const TDesC8& aData, TUint8 aDcs, 

   327 			RMobileUssdMessaging::TMobileUssdDataFormat aFormat, RMobileUssdMessaging::TMobileUssdMessageType aType) = 0;

   328 

   329 	}; // class MLtsyDispatchSupplementaryServicesSendUssdMessage

   330 

   331 

   332 class MLtsyDispatchSupplementaryServicesSendUssdMessageNoFdnCheck : public MLtsyDispatchInterface

   333 	{

   334 public:

   335 

   336 	static const TInt KLtsyDispatchSupplementaryServicesSendUssdMessageNoFdnCheckApiId = KDispatchSupplementaryServicesFuncUnitId + 11;

   337 

   338 	/**

   339 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobileUssdMessagingSendMessageNoFdnCheck

   340 	 * request from the CTSY.

   341 	 *

   342 	 * It is a request call that is completed by invoking

   343 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSendUssdMessageNoFdnCheckComp()

   344 	 * 

   345 	 * Implementation of this interface should send an USSD message to the network without initially checking FDN lsit.

   346 	 *

   347 	 *

   348 	 * @param aData The actual data to send in the message.

   349 	 * @param aDcs The data coding scheme of the message.

   350 	 * @param aFormat The message format.

   351 	 * @param aType The message type (RMobileUssdMessaging::EUssdMORequest, RMobileUssdMessaging::EUssdMOReply 

   352 	 * or RMobileUssdMessaging::EUssdMOAcknowledgement).

   353 	 *

   354 	 * @return KErrNone on success, KErrGsmSSUssdBusy if the latest USSD session was not yet released, 

   355 	 * otherwise another error code indicating the failure.

   356 	 */

   357 	virtual TInt HandleSendUssdMessageNoFdnCheckReqL(const TDesC8& aData, TUint8 aDcs, 

   358 			RMobileUssdMessaging::TMobileUssdDataFormat aFormat, RMobileUssdMessaging::TMobileUssdMessageType aType) = 0;

   359 

   360 	}; // class MLtsyDispatchSupplementaryServicesSendUssdMessageNoFdnCheck

   361 

   362 

   363 class MLtsyDispatchSupplementaryServicesSendUssdRelease : public MLtsyDispatchInterface

   364 	{

   365 public:

   366 

   367 	static const TInt KLtsyDispatchSupplementaryServicesSendUssdReleaseApiId = KDispatchSupplementaryServicesFuncUnitId + 12;

   368 

   369 	/**

   370 	 * The CTSY Dispatcher shall invoke this function on receiving the EMobileUssdMessagingSendRelease

   371 	 * request from the CTSY.

   372 	 *

   373 	 * It is a request call that is completed by invoking

   374 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesSendUssdReleaseComp()

   375 	 *

   376 	 * Implementation of this interface should send a USSD release message to the network.

   377 	 *

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

   379 	 * failure.

   380 	 */

   381 	virtual TInt HandleSendUssdReleaseReqL() = 0;

   382 

   383 	}; // class MLtsyDispatchSupplementaryServicesSendUssdRelease

   384 

   385 

   386 

   387 class MLtsyDispatchSupplementaryServicesClearBlacklist : public MLtsyDispatchInterface

   388 	{

   389 public:

   390 

   391 	static const TInt KLtsyDispatchSupplementaryServicesClearBlacklistApiId = KDispatchSupplementaryServicesFuncUnitId + 13;

   392 

   393 	/**

   394 	 * The CTSY Dispatcher shall invoke this function on receiving the ECustomClearCallBlackListIPC

   395 	 * request from the CTSY.

   396 	 *

   397 	 * It is a request call that is completed by invoking

   398 	 * CCtsyDispatcherCallback::CallbackSupplementaryServicesClearBlacklistComp()

   399 	 * 

   400 	 * Implementation of this interface should clear the blacklist.

   401 	 *

   402 	 *

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

   404 	 */

   405 	virtual TInt HandleClearBlacklistReqL() = 0;

   406 

   407 	}; // class MLtsyDispatchSupplementaryServicesClearBlacklist

   408 

   409 

   410 #endif /*MLTSYDISPATCHSUPPLEMENTARYSERVICESINTERFACE_H_*/