imservices/ossprotocoladaptation/tsrc/ossadapmt/inc/ossadapmt.h
changeset 46 860cd8a5168c
parent 35 085f765766a0
equal deleted inserted replaced
35:085f765766a0 46:860cd8a5168c
     1 /*
       
     2 * Copyright (c) 2002 - 2007 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:  ossadapmt.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef OSSADAPMT_H
       
    21 #define OSSADAPMT_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <StifLogger.h>
       
    25 #include <TestScripterInternal.h>
       
    26 #include <StifTestModule.h>
       
    27 #include <flogger.h>
       
    28 
       
    29 // CONSTANTS
       
    30 //const ?type ?constant_var = ?constant;
       
    31 
       
    32 // MACROS
       
    33 //#define ?macro ?macro_def
       
    34 // Logging path
       
    35 _LIT ( KossadapmtLogPath, "\\logs\\testframework\\ossadapmt\\" );
       
    36 // Log file
       
    37 _LIT ( KossadapmtLogFile, "ossadapmt.txt" );
       
    38 _LIT ( KossadapmtLogFileWithTitle, "ossadapmt_[%S].txt" );
       
    39 
       
    40 // FUNCTION PROTOTYPES
       
    41 //?type ?function_name(?arg_list);
       
    42 
       
    43 // FORWARD DECLARATIONS
       
    44 //class ?FORWARD_CLASSNAME;
       
    45 
       
    46 class Cossadapmt;
       
    47 
       
    48 enum TSearch 
       
    49 	{
       
    50 	ESimpleSearch,
       
    51 	EMultipleSearch,
       
    52 	ESearchNoResults,
       
    53 	ESearchManyResults,
       
    54 	ESearchBlank,
       
    55 	ESearchMaxChars,
       
    56 	ESearchSpecialChars,
       
    57 	ESearchEmailid,
       
    58 	ESearchAndAddToIm,
       
    59 	ESecondSearch,
       
    60 	EGetSearchKeyEnum,
       
    61 	EGetSearchKeyLabel,
       
    62 	EGetSearchKeyEnumNLabel,		
       
    63 	};
       
    64 
       
    65 // DATA TYPES
       
    66 //enum ?declaration
       
    67 //typedef ?declaration
       
    68 //extern ?data_type;
       
    69 
       
    70 // CLASS DECLARATION
       
    71 
       
    72 /**
       
    73 *  Cossadapmt test class for STIF Test Framework TestScripter.
       
    74 *  ?other_description_lines
       
    75 *
       
    76 *  @lib ?library
       
    77 *  @since ?Series60_version
       
    78 */
       
    79 NONSHARABLE_CLASS ( Cossadapmt ) : public CScriptBase
       
    80 	{
       
    81 
       
    82 public:  // Constructors and destructor
       
    83 
       
    84 	/**
       
    85 	* Two-phased constructor.
       
    86 	*/
       
    87 	static Cossadapmt* NewL ( CTestModuleIf& aTestModuleIf );
       
    88 
       
    89 	/**
       
    90 	* Destructor.
       
    91 	*/
       
    92 	virtual ~Cossadapmt();
       
    93 
       
    94 public: // New functions
       
    95 
       
    96 	/**
       
    97 	* ?member_description.
       
    98 	* @since ?Series60_version
       
    99 	* @param ?arg1 ?description
       
   100 	* @return ?description
       
   101 	*/
       
   102 	//?type ?member_function( ?type ?arg1 );
       
   103 
       
   104 public: // Functions from base classes
       
   105 
       
   106 	/**
       
   107 	* From CScriptBase Runs a script line.
       
   108 	* @since ?Series60_version
       
   109 	* @param aItem Script line containing method name and parameters
       
   110 	* @return Symbian OS error code
       
   111 	*/
       
   112 	virtual TInt RunMethodL ( CStifItemParser& aItem );
       
   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 	Cossadapmt ( 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 	* Bind test method.
       
   160 	* @since ?Series60_version
       
   161 	* @param aItem Script line containing parameters.
       
   162 	* @return Symbian OS error code.
       
   163 	*/
       
   164 	virtual TInt LoginL ( CStifItemParser& aItem );
       
   165 	virtual TInt Login_InvalidDataL ( CStifItemParser& aItem );
       
   166 	virtual TInt Login8HrsLogoutL ( CStifItemParser& aItem );
       
   167 	virtual TInt LoginLogout_LoginLogoutL ( CStifItemParser& aItem );
       
   168 	/**
       
   169 	* UnBind test method.
       
   170 	*/
       
   171 	virtual TInt UnBindL ( CStifItemParser& aItem );
       
   172 	/**
       
   173 	* Fetch contacts method
       
   174 	*/
       
   175 	virtual TInt GetContactsL ( CStifItemParser& aItem );
       
   176 
       
   177 	/**
       
   178 	* Send message test method.
       
   179 	*/
       
   180 	virtual TInt SendMessageL ( CStifItemParser& aItem );
       
   181 	virtual TInt SendEmptyMessageL ( CStifItemParser& aItem );
       
   182 	virtual TInt SendTenMessageL ( CStifItemParser& aItem );
       
   183 	virtual TInt SendTwentyMessageL ( CStifItemParser& aItem );
       
   184 	virtual TInt SendMessage_MultipleContactsL ( CStifItemParser& aItem );
       
   185 
       
   186 	/**
       
   187 	* Receive message test method
       
   188 	*/
       
   189 	virtual TInt ReceiveMessageL ( CStifItemParser& aItem );
       
   190 	virtual TInt ReceiveEmptyMessageL ( CStifItemParser& aItem );
       
   191 	virtual TInt ReceiveTenMessageL ( CStifItemParser& aItem );
       
   192 	virtual TInt ReceiveTwentyMessageL ( CStifItemParser& aItem );
       
   193 
       
   194 	/**
       
   195 	*contact list manangement test methods
       
   196 	*/
       
   197 	virtual TInt AddConatctL ( CStifItemParser& aItem );
       
   198 	virtual TInt AcceptnotificationRequestL ( CStifItemParser& aItem );
       
   199 	virtual TInt AddBlankConatctL ( CStifItemParser& aItem );
       
   200 	virtual TInt AddBlankConatct1L ( CStifItemParser& aItem );
       
   201 	
       
   202     virtual TInt DeleteConatctL ( CStifItemParser& aItem );
       
   203     virtual TInt DeleteBlankConatctL ( CStifItemParser& aItem );
       
   204    /**
       
   205 	* Presence publishing test method
       
   206 	*/
       
   207 	virtual TInt PublishOwnPresenceL ( CStifItemParser& aItem );
       
   208 	virtual TInt PublishOwnPresenceEmptyTextL ( CStifItemParser& aItem );
       
   209 	virtual TInt RejectAddnotificationRequestL ( CStifItemParser& aItem );
       
   210 	virtual TInt ImOperationsCoverageL ( CStifItemParser& aItem );
       
   211 	
       
   212 	virtual TInt SearchL ( CStifItemParser& aItem, TSearch aSearchType );
       
   213 	virtual TInt SimpleSearchL( CStifItemParser& aItem );
       
   214 	virtual TInt MultipleSearchL( CStifItemParser& aItem );
       
   215 	virtual TInt NoResultSearchL( CStifItemParser& aItem );
       
   216 	virtual TInt ManyResultsSearchL( CStifItemParser& aItem );
       
   217 	virtual TInt BlankSearchL( CStifItemParser& aItem );
       
   218 	virtual TInt MaxCharSearchL( CStifItemParser& aItem );
       
   219 	virtual TInt SpecialCharSearchL( CStifItemParser& aItem );
       
   220 	virtual TInt SearchEmailIDL( CStifItemParser& aItem );
       
   221    	virtual TInt SearchAndAddToIML( CStifItemParser& aItem );
       
   222    	virtual TInt SecondSearchL( CStifItemParser& aItem );
       
   223    	virtual TInt GetSearchKeyEnumL( CStifItemParser& aItem );
       
   224    	virtual TInt GetSearchKeyLabelL( CStifItemParser& aItem );
       
   225    	virtual TInt GetSearchKeyEnumNLabelL( CStifItemParser& aItem );
       
   226     virtual TInt SetAvtarL( CStifItemParser& aItem );
       
   227 public:     // Data
       
   228 	// ?one_line_short_description_of_data
       
   229 	//?data_declaration;
       
   230 
       
   231 protected:  // Data
       
   232 	// ?one_line_short_description_of_data
       
   233 	//?data_declaration;
       
   234 
       
   235 private:    // Data
       
   236 
       
   237 	// ?one_line_short_description_of_data
       
   238 	//?data_declaration;
       
   239 
       
   240 	// Reserved pointer for future extension
       
   241 	//TAny* iReserved;
       
   242 
       
   243 public:     // Friend classes
       
   244 	//?friend_class_declaration;
       
   245 
       
   246 protected:  // Friend classes
       
   247 	//?friend_class_declaration;
       
   248 
       
   249 private:    // Friend classes
       
   250 	//?friend_class_declaration;
       
   251 
       
   252 	};
       
   253 
       
   254 class TOssAdapMtLogger
       
   255 	{
       
   256 
       
   257 	public: // New functions
       
   258 		/**
       
   259 		    * Writes log to log file
       
   260 		    */
       
   261 		static void Log ( TRefByValue<const TDesC> aFmt, ... );
       
   262 
       
   263 	};
       
   264 
       
   265 
       
   266 
       
   267 #endif      // OSSADAPMT_H
       
   268 
       
   269 // End of File