locsrv_plat/supl_settings_api/tsrc/inc/settingsapi.h
changeset 0 667063e416a2
child 22 4c4ed41530db
child 31 380473e13443
equal deleted inserted replaced
-1:000000000000 0:667063e416a2
       
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Declaration of settings api classes
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef SUPLSERVER_H
       
    21 #define SUPLSERVER_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <StifLogger.h>
       
    25 #include <TestScripterInternal.h>
       
    26 #include <StifTestModule.h>
       
    27 #include <epos_suplterminal.h>
       
    28 #include <epos_CSuplSettings.h>
       
    29 #include <epos_MSuplSettingsObserver.h>
       
    30 #include <epos_csuplsettingparams.h>
       
    31 
       
    32 //#include <epos_csuplsettingsengine.h>
       
    33 
       
    34 class CObserverTest;
       
    35 class MSuplSettingsObserver;
       
    36 class CServerParamValues;
       
    37 class CSuplSettingsInternal;
       
    38 // CONSTANTS
       
    39 //const ?type ?constant_var = ?constant;
       
    40 
       
    41 // MACROS
       
    42 //#define ?macro ?macro_def
       
    43 // Logging path
       
    44 _LIT( KsuplserverLogPath, "c:\\logs\\testframework\\suplsettings\\" ); 
       
    45 // Log file
       
    46 _LIT( KsuplserverLogFile, "suplsettings.txt" ); 
       
    47 
       
    48 // FUNCTION PROTOTYPES
       
    49 //?type ?function_name(?arg_list);
       
    50 
       
    51 // FORWARD DECLARATIONS
       
    52 //class ?FORWARD_CLASSNAME;
       
    53 class CSettingsApi;
       
    54 class CTerminalInitiatedRunSession;
       
    55 class MSettingsObserver
       
    56 {
       
    57 	public:
       
    58 	virtual void CompleteInitialize(TInt err)=0;
       
    59 };
       
    60 // DATA TYPES
       
    61 //enum ?declaration
       
    62 //typedef ?declaration
       
    63 //extern ?data_type;
       
    64 
       
    65 // CLASS DECLARATION
       
    66 
       
    67 /**
       
    68 *  CSettingsApi test class for STIF Test Framework TestScripter.
       
    69 *  ?other_description_lines
       
    70 *
       
    71 *  @lib ?library
       
    72 *  @since ?Series60_version
       
    73 */
       
    74 NONSHARABLE_CLASS(CSettingsApi) : public CScriptBase, public MSuplSettingsObserver, public MSettingsObserver
       
    75     {
       
    76     public:  // Constructors and destructor
       
    77         
       
    78         /**
       
    79         * Two-phased constructor.
       
    80         */
       
    81         static CSettingsApi* NewL( CTestModuleIf& aTestModuleIf );
       
    82         
       
    83         /**
       
    84         * Destructor.
       
    85         */
       
    86         virtual ~CSettingsApi();
       
    87 
       
    88     public: // New functions
       
    89         
       
    90         /**
       
    91         * ?member_description.
       
    92         * @since ?Series60_version
       
    93         * @param ?arg1 ?description
       
    94         * @return ?description
       
    95         */
       
    96         //?type ?member_function( ?type ?arg1 );
       
    97       
       
    98 		//	void 	HandleSuplSettingsChangeL(TSuplSettingsEventType aEvent,TBool aDBNotifier = EFalse);
       
    99 			void HandleSuplSettingsChangeL(TSuplSettingsEventType aEvent,TInt aSlpId = -1 );
       
   100                        
       
   101     public: // Functions from base classes
       
   102 
       
   103         /**
       
   104         * From CScriptBase Runs a script line.
       
   105         * @since ?Series60_version
       
   106         * @param aItem Script line containing method name and parameters
       
   107         * @return Symbian OS error code
       
   108         */
       
   109         virtual TInt RunMethodL( CStifItemParser& aItem );
       
   110         void GetImsiTest(CSuplSettings*);
       
   111        
       
   112         void CompleteInitialize(TInt err);
       
   113                 
       
   114     protected:  // New functions
       
   115         
       
   116         /**
       
   117         * ?member_description.
       
   118         * @since ?Series60_version
       
   119         * @param ?arg1 ?description
       
   120         * @return ?description
       
   121         */
       
   122         //?type ?member_function( ?type ?arg1 );
       
   123 
       
   124     protected:  // Functions from base classes
       
   125         
       
   126         /**
       
   127         * From ?base_class ?member_description
       
   128         */
       
   129         //?type ?member_function();
       
   130 
       
   131     private:
       
   132 
       
   133         /**
       
   134         * C++ default constructor.
       
   135         */
       
   136         CSettingsApi( CTestModuleIf& aTestModuleIf );
       
   137 
       
   138         /**
       
   139         * By default Symbian 2nd phase constructor is private.
       
   140         */
       
   141         void ConstructL();
       
   142 
       
   143         // Prohibit copy constructor if not deriving from CBase.
       
   144         // ?classname( const ?classname& );
       
   145         // Prohibit assigment operator if not deriving from CBase.
       
   146         // ?classname& operator=( const ?classname& );
       
   147     
       
   148         /**
       
   149         * Frees all resources allocated from test methods.
       
   150         * @since ?Series60_version
       
   151         */
       
   152         void Delete();
       
   153         
       
   154         /**
       
   155         * Test methods are listed below. 
       
   156         */
       
   157         
       
   158         /**
       
   159         * Example test method.
       
   160         * @since ?Series60_version
       
   161         * @param aItem Script line containing parameters.
       
   162         * @return Symbian OS error code.
       
   163         */
       
   164         //TInt TestConnect( CStifItemParser& aItem );
       
   165        //priya
       
   166         TInt InitializeImsi();
       
   167         
       
   168         TInt ListenForChanges();
       
   169         TInt CancelInitializeTest();
       
   170         TInt GetHslpFromImsi();
       
   171         TInt IsImsiChangedTest();
       
   172         TInt RemoveObserver();
       
   173         TInt GetImsiWithoutInitialize();
       
   174         TInt RemoveBeforeSetObserver();
       
   175         TInt IsImsiChangedWithoutInitialize();
       
   176         TInt GenerateHslpFromImsiWithoutInitialize();
       
   177         TInt GenerateHslpWithoutInitialize();
       
   178 			  TInt SetUsageAutomatic();
       
   179         TInt SetUsageAlwaysAsk();
       
   180         TInt SetUsageAutoInHMNw();
       
   181         TInt SetUsageDisabled();
       
   182         TInt GetUsageAutomatic();
       
   183         TInt GetUsageAlwaysAsk();
       
   184         TInt GetUsageAutoInHMNw();
       
   185         TInt GetUsageDisabled();
       
   186       	TInt SetUsageOtherThanAppropriate();
       
   187         TInt RemoveServer(CStifItemParser& aItem);
       
   188         TInt RemoveServer_Invalid_negative(CStifItemParser& aItem);
       
   189         TInt RemoveServer_Id_NotExisting(CStifItemParser& aItem);
       
   190         TInt RemoveServer_Invalid_zero(CStifItemParser& aItem);
       
   191         TInt CSettingsApi::ChangePriority_Increase(CStifItemParser& aItem);
       
   192         TInt CSettingsApi::ChangePriority_Decrease(CStifItemParser& aItem);
       
   193         TInt CSettingsApi::ChangePriority_invalid_positive(CStifItemParser& aItem);
       
   194         TInt CSettingsApi::ChangePriority_priority0(CStifItemParser& aItem);
       
   195         TInt CSettingsApi::ChangePriority_Negative(CStifItemParser& aItem);
       
   196         TInt CSettingsApi::ChangePriority_InvalidServer(CStifItemParser& aItem);
       
   197       	TInt CSettingsApi::ChangePriority_invalidserverpriority(CStifItemParser& aItem);
       
   198         TInt CSettingsApi::GetDefaultServer();
       
   199 				TInt CSettingsApi::AddNewServerWithDefault(CStifItemParser& aItem);
       
   200 				TInt CSettingsApi::AddNewServerWithoutDefault(CStifItemParser& aItem);
       
   201 				TInt CSettingsApi::AddNewServer_Duplicate(CStifItemParser& aItem);
       
   202 				TInt CSettingsApi::GetSlpInfoFromId(TInt64 Slpid);
       
   203 				TInt CSettingsApi::GetSlpInfoFromId(CStifItemParser& aItem);
       
   204 				TInt CSettingsApi::GetSlpInfoFromId_invalid_positive(CStifItemParser& aItem);
       
   205 				TInt CSettingsApi::GetSlpInfoFromId_invalid_negative(CStifItemParser& aItem);
       
   206 				TInt CSettingsApi::GetSlpInfoFromId_invalid_zero(CStifItemParser& aItem);
       
   207 				TInt CSettingsApi::SetServerAddress(CStifItemParser& aItem);
       
   208 				TInt CSettingsApi::SetServerAddress_invalidpositive(CStifItemParser& aItem);
       
   209 				TInt CSettingsApi::SetServerAddress_invalidnegative(CStifItemParser& aItem);
       
   210 				TInt CSettingsApi::SetServerAddress_invalidzero(CStifItemParser& aItem);
       
   211 				TInt CSettingsApi::SetServerAddress_AddressNull(CStifItemParser& aItem);
       
   212 				TInt CSettingsApi::SetServerAddress_InvalidAddressId(CStifItemParser& aItem);
       
   213 				TInt CSettingsApi::GetServerAddress(CStifItemParser& aItem);
       
   214 				TInt CSettingsApi::GetServerAddress_invalidpositive(CStifItemParser& aItem);
       
   215 				TInt CSettingsApi::GetServerAddress_invalidnegative(CStifItemParser& aItem);
       
   216 				TInt CSettingsApi::GetServerAddress_invalidzero(CStifItemParser& aItem);
       
   217 				TInt CSettingsApi::GetServerAddress(TInt64 aSlpId1);
       
   218 				TInt CSettingsApi::SetIAPName_InvalidAddressId(CStifItemParser& aItem);
       
   219 				TInt CSettingsApi::SetIAPName_invalidzero(CStifItemParser& aItem);
       
   220 				TInt CSettingsApi::SetIAPName_invalidnegative(CStifItemParser& aItem);
       
   221 				TInt CSettingsApi::SetIAPName_invalidpositive(CStifItemParser& aItem);
       
   222 				TInt CSettingsApi::SetIAPName(CStifItemParser& aItem);
       
   223 				 TInt CSettingsApi::GetIAPName_invalidzero(CStifItemParser& aItem);
       
   224 				 TInt CSettingsApi::GetIAPName_invalidnegative(CStifItemParser& aItem);
       
   225 				 TInt CSettingsApi::GetIAPName_invalidpositive(CStifItemParser& aItem);
       
   226 				 TInt CSettingsApi::GetIAPName(CStifItemParser& aItem);
       
   227 				 TInt CSettingsApi::GetIAPName(TInt64 aSlpId1);
       
   228 				 TInt CSettingsApi::SetServerEnabledFlag_Etrue(CStifItemParser& aItem);
       
   229 				 TInt CSettingsApi::SetServerEnabledFlag_EFalse(CStifItemParser& aItem);
       
   230 				 TInt CSettingsApi::SetServerEnabledFlag_id_negative(CStifItemParser& aItem);
       
   231 				 TInt CSettingsApi::SetServerEnabledFlag_id_positive(CStifItemParser& aItem);
       
   232 				  TInt CSettingsApi::SetServerEnabledFlag_id_zero(CStifItemParser& aItem);
       
   233 				 TInt CSettingsApi::GetServerEnabledFlag_id_negative(CStifItemParser& aItem);
       
   234 				  TInt CSettingsApi::GetServerEnabledFlag_id_positive(CStifItemParser& aItem);
       
   235 				  TInt CSettingsApi::GetServerEnabledFlag_id_zero(CStifItemParser& aItem);
       
   236 				  TInt CSettingsApi::GetServerEnabledFlag_EFalse(CStifItemParser& aItem);
       
   237 				  TInt CSettingsApi::GetServerEnabledFlag_Etrue(CStifItemParser& aItem);
       
   238 				  TInt CSettingsApi::GetUsageInHomeNwFlag(TInt64 aSlpId1);
       
   239 				  TInt CSettingsApi::SetUsageInHomwNwFlag_Etrue(CStifItemParser& aItem);
       
   240 				  TInt CSettingsApi::SetUsageInHomwNwFlag_EFalse(CStifItemParser& aItem);
       
   241 				  TInt CSettingsApi::SetUsageInHomwNwFlag_id_negative(CStifItemParser& aItem);
       
   242 				  TInt CSettingsApi::SetUsageInHomwNwFlag_id_positive(CStifItemParser& aItem);
       
   243 				   TInt CSettingsApi::SetUsageInHomwNwFlag_id_zero(CStifItemParser& aItem);
       
   244 					 TInt CSettingsApi::GetUsageInHomwNwFlag_Etrue(CStifItemParser& aItem);
       
   245 				   TInt CSettingsApi::GetUsageInHomwNwFlag_EFalse(CStifItemParser& aItem);
       
   246 				   TInt CSettingsApi::GetUsageInHomwNwFlag_id_negative(CStifItemParser& aItem);
       
   247 				   TInt CSettingsApi::GetUsageInHomwNwFlag_id_positive(CStifItemParser& aItem);
       
   248 				   TInt CSettingsApi::GetUsageInHomwNwFlag_id_zero(CStifItemParser& aItem);
       
   249 				   TInt CSettingsApi::GetUsageInHomwNwFlag(TInt64 aSlpId1);
       
   250 				 TInt CSettingsApi::AddNewServer_aServerAddress_Null(CStifItemParser& aItem);
       
   251 				  TInt CSettingsApi::AddNewServer_aIapNAme_Null(CStifItemParser& aItem);
       
   252 				 TInt CSettingsApi::SetDefaultServer_aServerAddress_Null(CStifItemParser& aItem);
       
   253 	 TInt CSettingsApi::SetDefaultServerWithDefaultValues(CStifItemParser& aItem);
       
   254 				 TInt CSettingsApi::SetAllParameter_aServerAddress_Null(CStifItemParser& aItem);
       
   255   TInt CSettingsApi::SetAllParameter_WithDefaultValues(CStifItemParser& aItem);
       
   256 				 TInt CSettingsApi::SetAllParameter_Invalid_Positive(CStifItemParser& aItem);
       
   257 				 TInt CSettingsApi::SetAllParameter_Invalid_Negative(CStifItemParser& aItem);
       
   258 				 TInt CSettingsApi::SetAllParameter_Invalid_Zero(CStifItemParser& aItem);
       
   259 				TInt CSettingsApi::GetServerEnabledFlag(TInt64 aSlpId1);
       
   260 				TInt CSettingsApi::SetEditableFlag_Etrue(CStifItemParser& aItem);
       
   261 				TInt CSettingsApi::SetEditableFlag_EFalse(CStifItemParser& aItem);
       
   262 				TInt CSettingsApi::SetEditableFlag_id_negative(CStifItemParser& aItem);
       
   263 				TInt CSettingsApi::SetEditableFlag_id_positive(CStifItemParser& aItem);
       
   264 				TInt CSettingsApi::SetEditableFlag_id_zero(CStifItemParser& aItem);
       
   265 				TBool CSettingsApi::IsSLPExists(CStifItemParser& aItem);
       
   266 				TBool CSettingsApi::IsSLPExists_invalid_negative(CStifItemParser& aItem);
       
   267 				TBool CSettingsApi::IsSLPExists_invalid_positive(CStifItemParser& aItem);
       
   268 				TBool CSettingsApi::IsSLPExists_invalid_zero(CStifItemParser& aItem);
       
   269 				TInt CSettingsApi::GetAllSlp_sync(CStifItemParser& aItem);
       
   270 				TInt CSettingsApi::GetAllSlp_async(CStifItemParser& aItem);
       
   271 				TInt CSettingsApi::SetSimChangeRemoveFlag_Etrue(CStifItemParser& aItem);
       
   272 				TInt CSettingsApi::SetSimChangeRemoveFlag_EFalse(CStifItemParser& aItem);
       
   273 				TInt CSettingsApi::SetSimChangeRemoveFlag_id_negative(CStifItemParser& aItem);
       
   274 				TInt CSettingsApi::SetSimChangeRemoveFlag_id_positive(CStifItemParser& aItem);
       
   275 				TInt CSettingsApi::SetSimChangeRemoveFlag_id_zero(CStifItemParser& aItem);
       
   276 				TInt CSettingsApi::GetSimChangeRemoveFlag_Etrue(CStifItemParser& aItem);
       
   277 				TInt CSettingsApi::GetSimChangeRemoveFlag(TInt64 aSlpId1);
       
   278 				TInt CSettingsApi::GetSimChangeRemoveFlag_EFalse(CStifItemParser& aItem);
       
   279 				TInt CSettingsApi::GetSimChangeRemoveFlag_id_negative(CStifItemParser& aItem);
       
   280 				TInt CSettingsApi::GetSimChangeRemoveFlag_id_positive(CStifItemParser& aItem);
       
   281 				TInt CSettingsApi::GetSimChangeRemoveFlag_id_zero(CStifItemParser& aItem);
       
   282 				TInt CSettingsApi::GetEditableFlag_Etrue(CStifItemParser& aItem);
       
   283 				TInt CSettingsApi::GetEditableFlag(TInt64 aSlpId1);
       
   284 				TInt CSettingsApi::GetEditableFlag_EFalse(CStifItemParser& aItem);
       
   285 				TInt CSettingsApi::GetEditableFlag_id_negative(CStifItemParser& aItem);
       
   286 				TInt CSettingsApi::GetEditableFlag_id_positive(CStifItemParser& aItem);
       
   287 				TInt CSettingsApi::GetEditableFlag_id_zero(CStifItemParser& aItem);
       
   288 				TInt CSettingsApi::SetFallBack_ETrue();
       
   289 				TInt CSettingsApi::SetFallBack_EFalse();
       
   290 				TInt CSettingsApi::GetFallBack();
       
   291 				TInt CSettingsApi::IsSLPExistsString();
       
   292 				TInt CSettingsApi::IsSLPExistsString_Null();
       
   293 				TInt CSettingsApi::IsSLPExistsString_invalid();
       
   294 				TInt CSettingsApi::SlpCount();
       
   295 				TInt CSettingsApi::GetSlpInfoFromAddress(CStifItemParser& aItem);
       
   296 				TInt CSettingsApi::GetSlpInfoFromAddress_invalid(CStifItemParser& aItem);
       
   297 		
       
   298 				TInt SetGetTriggerParamsL( CStifItemParser& aItem ); 
       
   299 				
       
   300                 
       
   301         virtual TInt GetAllSessionSetApiL( CStifItemParser& aItem );
       
   302        
       
   303               
       
   304         
       
   305        
       
   306         virtual TInt SetSessionObserverL( CStifItemParser& aItem );
       
   307         virtual TInt SetSessionObserverTwiceL( CStifItemParser& aItem );
       
   308         virtual TInt RemoveSessionObserverL( CStifItemParser& aItem );
       
   309         virtual TInt RemoveSessionObserverWithoutSetL( CStifItemParser& aItem );
       
   310         virtual TInt CheckSessionChangeEventsL( CStifItemParser& aItem );
       
   311         
       
   312         virtual TInt GetASessionParamNullL( CStifItemParser& aItem );
       
   313         virtual TInt GetASessionParamInValidL( CStifItemParser& aItem );
       
   314         virtual TInt CancelTriggerSessionL( CStifItemParser& aItem );
       
   315         
       
   316        
       
   317         virtual TInt SetTriggerEmptySessionNameL( CStifItemParser& aItem );
       
   318         virtual TInt SetTriggerLongSessionNameL( CStifItemParser& aItem );
       
   319 
       
   320 
       
   321 
       
   322 				   
       
   323     public:     // Data
       
   324         // ?one_line_short_description_of_data
       
   325         //?data_declaration;
       
   326     
       
   327     protected:  // Data
       
   328         // ?one_line_short_description_of_data
       
   329         //?data_declaration;
       
   330 
       
   331     private:    // Data
       
   332         
       
   333         // ?one_line_short_description_of_data
       
   334         //?data_declaration;
       
   335          
       
   336         // Reserved pointer for future extension
       
   337         //TAny* iReserved;
       
   338 		MSuplSettingsObserver *iObs;
       
   339     public:     // Friend classes
       
   340         //?friend_class_declaration;
       
   341     protected:  // Friend classes
       
   342         //?friend_class_declaration;
       
   343     private:    // Friend classes
       
   344         //?friend_class_declaration;
       
   345         CActiveScheduler *iScheduler;
       
   346         	CSuplSettings *iSettings;
       
   347         	CSuplSettingsInternal *cSettings;
       
   348         	CTerminalInitiatedRunSession *imyAO;
       
   349         	TInt iTestid;
       
   350         	TInt iErrCode;
       
   351         	TInt iSlpId;
       
   352         	
       
   353 };
       
   354     
       
   355 
       
   356 class CTerminalInitiatedRunSession : public CActive
       
   357 	{
       
   358 	public :
       
   359 
       
   360     CTerminalInitiatedRunSession();
       
   361 	static CTerminalInitiatedRunSession* NewL(MSettingsObserver *aObserver);
       
   362 		
       
   363 	void ConstructL(MSettingsObserver *aObserver);
       
   364 	
       
   365 	~CTerminalInitiatedRunSession();
       
   366 	void RunSession(CSuplSettings *aSettings);
       
   367 	//void GetPositionL(TSuplPosition& aPosition);
       
   368 	
       
   369 	void RunL();
       
   370 	void DoCancel();
       
   371 	void CancelRunSession(CSuplSettings *aSettings);
       
   372 	void StartListening();
       
   373 	
       
   374 	private:
       
   375 	
       
   376    CSuplSettings *iSettings;
       
   377    CSettingsApi *iTest;
       
   378    	CSuplSettingsInternal *cSettings;
       
   379    MSettingsObserver *iObserver;
       
   380    RTimer iTimer;
       
   381     
       
   382 	};
       
   383 class CObserverTest: public MSuplSettingsObserver
       
   384 {
       
   385 	public:
       
   386 
       
   387 	
       
   388 	private:
       
   389 	MSuplSettingsObserver *iObserver;
       
   390 	
       
   391 	
       
   392 	 private:    // Constructor
       
   393         /**
       
   394         * C++ Constructor
       
   395         */
       
   396         CObserverTest(MSuplSettingsObserver *aObserver);
       
   397 
       
   398     public:     // Destructor
       
   399         /**
       
   400         * C++ Destructor
       
   401         */
       
   402         ~CObserverTest();
       
   403 
       
   404         /**
       
   405         * Two-phase constructor
       
   406         */
       
   407         static CObserverTest* NewL(MSuplSettingsObserver *aObserver);
       
   408 
       
   409     private:
       
   410         /**
       
   411         * EPOC default constructor
       
   412         */
       
   413         void ConstructL();
       
   414 
       
   415         // By default, prohibit copy constructor
       
   416         CObserverTest( const CObserverTest& );
       
   417 	
       
   418 };
       
   419 #endif      // SUPLSERVER_H            
       
   420 // End of File
       
   421 
       
   422