messagingfw/deprecate/send_ui_api/tsrc/bc/inc/SendUIAPITest.h
branchRCL_3
changeset 22 d2c4c66342f3
equal deleted inserted replaced
21:e5b3a2155e1a 22:d2c4c66342f3
       
     1 /*
       
     2 * Copyright (c) 2002-2009 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:         SendUIAPITest  declaration
       
    15 
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 
       
    26 
       
    27 
       
    28 #ifndef SENDUIAPITEST_H
       
    29 #define SENDUIAPITEST_H
       
    30 
       
    31 //  INCLUDES
       
    32 #include <StifLogger.h>
       
    33 #include <TestScripterInternal.h>
       
    34 #include <StifTestModule.h>
       
    35 #include <TestclassAssert.h>
       
    36 #include <CMessageData.h>
       
    37 
       
    38 #include <bc_plat.h>
       
    39 
       
    40 // CONSTANTS
       
    41 //const ?type ?constant_var = ?constant;
       
    42 
       
    43 // MACROS
       
    44 //#define ?macro ?macro_def
       
    45 #if  ! defined( __SERIES60_31__ ) && ! defined( __SERIES60_30__ )	
       
    46 #define TEST_CLASS_VERSION_MAJOR 32
       
    47 #else if
       
    48 #define TEST_CLASS_VERSION_MAJOR 30
       
    49 #endif
       
    50 
       
    51 #define TEST_CLASS_VERSION_MINOR 9
       
    52 #define TEST_CLASS_VERSION_BUILD 6
       
    53 
       
    54 // Logging path
       
    55 _LIT( KSendUIAPITestLogPath, "\\logs\\testframework\\SendUIAPITest\\" ); 
       
    56 // Log file
       
    57 _LIT( KSendUIAPITestLogFile, "SendUIAPITest.txt" ); 
       
    58 _LIT( KSendUIAPITestLogFileWithTitle, "SendUIAPITest_[%S].txt" );
       
    59 
       
    60 // FUNCTION PROTOTYPES
       
    61 //?type ?function_name(?arg_list);
       
    62 
       
    63 // FORWARD DECLARATIONS
       
    64 //class ?FORWARD_CLASSNAME;
       
    65 class CMessageAddress;
       
    66 class CMessageData;
       
    67 class CSendUIAPITest;
       
    68 class CSendingServiceInfo;
       
    69 
       
    70 // DATA TYPES
       
    71 //enum ?declaration
       
    72 //typedef ?declaration
       
    73 //extern ?data_type;
       
    74 
       
    75 // CLASS DECLARATION
       
    76 
       
    77 
       
    78 /**
       
    79 *  CSendUIAPITest test class for STIF Test Framework TestScripter.
       
    80 *  ?other_description_lines
       
    81 *
       
    82 *  @lib ?library
       
    83 *  @since ?Series60_version
       
    84 */
       
    85 NONSHARABLE_CLASS(CSendUIAPITest) : public CScriptBase
       
    86     {
       
    87     public:  // Constructors and destructor
       
    88 
       
    89         /**
       
    90         * Two-phased constructor.
       
    91         */
       
    92         static CSendUIAPITest* NewL( CTestModuleIf& aTestModuleIf );
       
    93 
       
    94         /**
       
    95         * Destructor.
       
    96         */
       
    97         virtual ~CSendUIAPITest();
       
    98 
       
    99     public: // New functions
       
   100 
       
   101         /**
       
   102         * ?Function to create CMessageData object
       
   103         * @since ?Series60_version
       
   104         * @param ?void ?no input param
       
   105         * @CMessageData* ?CMessageData pointer object
       
   106         */
       
   107         CMessageData* InitL(void);
       
   108    
       
   109 
       
   110     public: // Functions from base classes
       
   111 
       
   112         /**
       
   113         * From CScriptBase Runs a script line.
       
   114         * @since ?Series60_version
       
   115         * @param aItem Script line containing method name and parameters
       
   116         * @return Symbian OS error code
       
   117         */
       
   118         virtual TInt RunMethodL( CStifItemParser& aItem );
       
   119 
       
   120     protected:  // New functions
       
   121 
       
   122         /**
       
   123         * ?member_description.
       
   124         * @since ?Series60_version
       
   125         * @param ?arg1 ?description
       
   126         * @return ?description
       
   127         */
       
   128         //?type ?member_function( ?type ?arg1 );
       
   129 
       
   130     protected:  // Functions from base classes
       
   131 
       
   132         /**
       
   133         * From ?base_class ?member_description
       
   134         */
       
   135         //?type ?member_function();
       
   136 
       
   137     private:
       
   138 
       
   139         /**
       
   140         * C++ default constructor.
       
   141         */
       
   142         CSendUIAPITest( CTestModuleIf& aTestModuleIf );
       
   143 
       
   144         /**
       
   145         * By default Symbian 2nd phase constructor is private.
       
   146         */
       
   147         void ConstructL();
       
   148 
       
   149         // Prohibit copy constructor if not deriving from CBase.
       
   150         // ?classname( const ?classname& );
       
   151         // Prohibit assigment operator if not deriving from CBase.
       
   152         // ?classname& operator=( const ?classname& );
       
   153 
       
   154         /**
       
   155         * Frees all resources allocated from test methods.
       
   156         * @since ?Series60_version
       
   157         */
       
   158         void Delete();
       
   159 		
       
   160         /**
       
   161         * Test methods are listed below. 
       
   162         */
       
   163 
       
   164         /**
       
   165         * Example test method.
       
   166         * @since ?Series60_version
       
   167         * @param aItem Script line containing parameters.
       
   168         * @return Symbian OS error code.
       
   169         */
       
   170         virtual TInt ExampleL( CStifItemParser& aItem );
       
   171         
       
   172         /**
       
   173          * Method used to log version of test class
       
   174          */
       
   175         void SendTestClassVersion();
       
   176 
       
   177 		/**
       
   178          * Method used to call SetSubjectL of CMessageData
       
   179          */
       
   180          virtual TInt MsgDataSetSubjectL( TPtrC& aSubject );
       
   181          
       
   182          /**
       
   183          * Method used to call SubjectL of CMessageData and Compare
       
   184          */
       
   185          virtual TInt MsgDataCompSubjectL( TPtrC& aSubject );
       
   186          
       
   187 		/**
       
   188         * Test Case for Calling CMessageData's NewL fun
       
   189         * @since ?Series60_version
       
   190         * @param aItem Script line containing parameters.
       
   191         * @return Symbian OS error code.
       
   192         */
       
   193       	
       
   194     	virtual TInt TestMessageDataNewL( CStifItemParser& aItem );
       
   195     	
       
   196     	/**
       
   197         * Test Case for Calling CMessageData's SetSubjectL fun
       
   198         * @since ?Series60_version
       
   199         * @param aItem Script line containing parameters.
       
   200         * @return Symbian OS error code.
       
   201         */
       
   202     	virtual TInt TestMessageDataSetSubjectL( CStifItemParser& aItem );
       
   203     	
       
   204     	/**
       
   205         * Test Case for Calling CMessageData's Subject fun
       
   206         * @since ?Series60_version
       
   207         * @param aItem Script line containing parameters.
       
   208         * @return Symbian OS error code.
       
   209         */
       
   210     	virtual TInt TestMessageDataSubjectL( CStifItemParser& aItem );
       
   211     	
       
   212     	/**
       
   213         * Test Case for Calling CMessageData's AppendAttachmentL fun
       
   214         * @since ?Series60_version
       
   215         * @param aItem Script line containing parameters.
       
   216         * @return Symbian OS error code.
       
   217         */
       
   218     	virtual TInt TestMessageDataAppendAttachmentL( CStifItemParser& aItem );
       
   219     	
       
   220     	/**
       
   221         * Test Case for Calling CMessageData's AttachmentArray fun
       
   222         * @since ?Series60_version
       
   223         * @param aItem Script line containing parameters.
       
   224         * @return Symbian OS error code.
       
   225         */
       
   226     	virtual TInt TestMessageDataAttachmentArrayL( CStifItemParser& aItem );
       
   227     	
       
   228     	/**
       
   229         * Test Case for Calling CMessageData's ClearAttachmentArray fun
       
   230         * @since ?Series60_version
       
   231         * @param aItem Script line containing parameters.
       
   232         * @return Symbian OS error code.
       
   233         */
       
   234     	virtual TInt TestMessageDataClearAttachmentArrayL( CStifItemParser& aItem );
       
   235     	
       
   236     	/**
       
   237         * Test Case for Calling CMessageData's AppendToAddressL fun
       
   238         * @since ?Series60_version
       
   239         * @param aItem Script line containing parameters.
       
   240         * @return Symbian OS error code.
       
   241         */
       
   242      	virtual TInt TestMessageDataAppendToAddressL( CStifItemParser& aItem );
       
   243      	
       
   244      	/**
       
   245         * Test Case for Calling CMessageData's ToAddressArray fun
       
   246         * @since ?Series60_version
       
   247         * @param aItem Script line containing parameters.
       
   248         * @return Symbian OS error code.
       
   249         */
       
   250      	virtual TInt TestMessageDataToAddressArrayL( CStifItemParser& aItem );
       
   251     	
       
   252     	/**
       
   253         * Test Case for Calling CMessageData's AppendCcAddressL fun
       
   254         * @since ?Series60_version
       
   255         * @param aItem Script line containing parameters.
       
   256         * @return Symbian OS error code.
       
   257         */
       
   258      	virtual TInt TestMessageDataAppendCcAddressL( CStifItemParser& aItem );
       
   259      	
       
   260      	/**
       
   261         * Test Case for Calling CMessageData's CcAddressArray fun
       
   262         * @since ?Series60_version
       
   263         * @param aItem Script line containing parameters.
       
   264         * @return Symbian OS error code.
       
   265         */
       
   266      	virtual TInt TestMessageDataCcAddressArrayL( CStifItemParser& aItem );
       
   267      	
       
   268      	/**
       
   269         * Test Case for Calling CMessageData's AppendBccAddressL fun
       
   270         * @since ?Series60_version
       
   271         * @param aItem Script line containing parameters.
       
   272         * @return Symbian OS error code.
       
   273         */
       
   274      	virtual TInt TestMessageDataAppendBccAddressL( CStifItemParser& aItem );
       
   275      	
       
   276      	/**
       
   277         * Test Case for Calling CMessageData's BccAddressArray fun
       
   278         * @since ?Series60_version
       
   279         * @param aItem Script line containing parameters.
       
   280         * @return Symbian OS error code.
       
   281         */
       
   282      	virtual TInt TestMessageDataBccAddressArrayL( CStifItemParser& aItem );
       
   283      	
       
   284      	/**
       
   285         * Test Case for Calling CMessageData's SetBodyTextL fun
       
   286         * @since ?Series60_version
       
   287         * @param aItem Script line containing parameters.
       
   288         * @return Symbian OS error code.
       
   289         */
       
   290      	virtual TInt TestMessageDataSetBodyTextL( CStifItemParser& aItem );
       
   291      	
       
   292      	/**
       
   293         * Test Case for Calling CMessageData's BodyText fun
       
   294         * @since ?Series60_version
       
   295         * @param aItem Script line containing parameters.
       
   296         * @return Symbian OS error code.
       
   297         */
       
   298      	virtual TInt TestMessageDataBodyTextL( CStifItemParser& aItem );
       
   299      	
       
   300      	/**
       
   301         * Test Case for Calling CMessageData's AppendAttachmentHandleL fun
       
   302         * @since ?Series60_version
       
   303         * @param aItem Script line containing parameters.
       
   304         * @return Symbian OS error code.
       
   305         */
       
   306      	virtual TInt  TestAppendAttachmentHandleL( CStifItemParser& aItem );
       
   307      	
       
   308      	/**
       
   309         * Test Case for Calling CMessageData's AttachmentHandleArray fun
       
   310         * @since ?Series60_version
       
   311         * @param aItem Script line containing parameters.
       
   312         * @return Symbian OS error code.
       
   313         */
       
   314      	virtual TInt  TestAttachmentHandleArrayL( CStifItemParser& aItem );
       
   315      	
       
   316      	/**
       
   317         * Test Case for Calling CMessageData's DataType fun
       
   318         * @since ?Series60_version
       
   319         * @param aItem Script line containing parameters.
       
   320         * @return Symbian OS error code.
       
   321         */
       
   322      	virtual TInt  TestDataTypeL( CStifItemParser& aItem );
       
   323      	
       
   324      	/**
       
   325         * Test Case for Calling CMessageData's ClearAddresses fun
       
   326         * @since ?Series60_version
       
   327         * @param aItem Script line containing parameters.
       
   328         * @return Symbian OS error code.
       
   329         */
       
   330      	virtual TInt  ClearAddressesL( CStifItemParser& aItem );
       
   331      	
       
   332      	/**
       
   333         * Test Case for Calling CMessageData's ExternalizeL and InternalizeL funs
       
   334         * @since ?Series60_version
       
   335         * @param aItem Script line containing parameters.
       
   336         * @return Symbian OS error code.
       
   337         */
       
   338         virtual TInt  TestExternalizeLnInternalizeL( CStifItemParser& aItem );	
       
   339         	
       
   340      	/**
       
   341         * Test Case for Calling CMessageData's ExternalizeL fun
       
   342         * @since ?Series60_version
       
   343         * @param void
       
   344         * @return Symbian OS error code.
       
   345         */
       
   346      	virtual TInt ExternalizeL( void );
       
   347     	
       
   348      	/**
       
   349         * Test Case for Calling CMessageData's InternalizeL fun
       
   350         * @since ?Series60_version
       
   351         * @param void
       
   352         * @return Symbian OS error code.
       
   353         */
       
   354      	virtual TInt InternalizeL( void );
       
   355      	
       
   356 
       
   357 
       
   358      	/**
       
   359         * Test Case for Calling CMessageData's SetOpaqueDataL fun
       
   360         * @since ?Series60_version
       
   361         * @param aItem Script line containing parameters.
       
   362         * @return Symbian OS error code.
       
   363         */
       
   364      	virtual TInt  TestSetOpaqueDataL( CStifItemParser& aItem );
       
   365      	
       
   366      	/**
       
   367         * Test Case for Calling CMessageData's OpaqueDataL fun
       
   368         * @since ?Series60_version
       
   369         * @param aItem Script line containing parameters.
       
   370         * @return Symbian OS error code.
       
   371         */
       
   372      	virtual TInt  TestOpaqueDataL( CStifItemParser& aItem );
       
   373      	
       
   374      	/**
       
   375         * Test Case for Calling CMessageAddress's NewL Construction
       
   376         * @since ?Series60_version
       
   377         * @param aItem Script line containing parameters.
       
   378         * @return Symbian OS error code.
       
   379         */
       
   380      	virtual TInt  TestCMessageAddressNewL( CStifItemParser& aItem );
       
   381      	     	
       
   382      	/**
       
   383         * Test Case for Calling CMessageAddress's SetAddressL 
       
   384         * @since ?Series60_version
       
   385         * @param aItem Script line containing parameters.
       
   386         * @return Symbian OS error code.
       
   387         */
       
   388      	virtual TInt  TestMsgAdrsSetAddressL( CStifItemParser& aItem );
       
   389      	
       
   390      	/**
       
   391         * Test Case for Calling CMessageAddress's Address 
       
   392         * @since ?Series60_version
       
   393         * @param aItem Script line containing parameters.
       
   394         * @return Symbian OS error code.
       
   395         */
       
   396      	virtual TInt  TestMsgAdrsAddress( CStifItemParser& aItem );
       
   397      	
       
   398      	/**
       
   399         * Test Case for Calling CMessageAddress's SetAliasL 
       
   400         * @since ?Series60_version
       
   401         * @param aItem Script line containing parameters.
       
   402         * @return Symbian OS error code.
       
   403         */
       
   404      	virtual TInt  TestMsgAdrsSetAliasL( CStifItemParser& aItem );
       
   405      	
       
   406      	/**
       
   407         * Test Case for Calling CMessageAddress's AliasL 
       
   408         * @since ?Series60_version
       
   409         * @param aItem Script line containing parameters.
       
   410         * @return Symbian OS error code.
       
   411         */
       
   412      	virtual TInt  TestMsgAdrsAlias( CStifItemParser& aItem );
       
   413      	
       
   414      	
       
   415      	/**
       
   416         * Test Case for Calling TSendingCapabilities functions
       
   417         * @since ?Series60_version
       
   418         * @param aItem Script line containing parameters.
       
   419         * @return Symbian OS error code.
       
   420         */
       
   421      	virtual TInt  TestTSendingCapabilities( CStifItemParser& aItem );
       
   422      	
       
   423     	
       
   424      	/**
       
   425         * Test Case for Calling CMessageAddress's ExternalizeL 
       
   426         * @since ?Series60_version
       
   427         * @param aItem Script line containing parameters.
       
   428         * @return Symbian OS error code.
       
   429         */
       
   430      	virtual TInt  TestMsgAdrsExternalizeL( CStifItemParser& aItem );
       
   431      	
       
   432      	/**
       
   433         * Test Case for Calling CMessageAddress's InternalizeL 
       
   434         * @since ?Series60_version
       
   435         * @param aItem Script line containing parameters.
       
   436         * @return Symbian OS error code.
       
   437         */
       
   438      	virtual TInt  TestMsgAdrsInternalizeL( CStifItemParser& aItem );
       
   439      	
       
   440      	/**
       
   441         * Test Case for Calling CSendingServiceInfo's CopyLC functions
       
   442         * @since ?Series60_version
       
   443         * @param aItem Script line containing parameters.
       
   444         * @return Symbian OS error code.
       
   445         */
       
   446      	virtual TInt TestCopyLC( CStifItemParser& aItem );
       
   447      	
       
   448      	/**
       
   449         * Test Case for Calling CSendingServiceInfo's SetTechnologyTypeId functions
       
   450         * @since ?Series60_version
       
   451         * @param aItem Script line containing parameters.
       
   452         * @return Symbian OS error code.
       
   453         */
       
   454      	virtual TInt TestSetTechnologyTypeIdL( CStifItemParser& aItem );
       
   455 
       
   456      	/**
       
   457         * Test Case for Calling CSendingServiceInfo's ServiceID functions
       
   458         * @since ?Series60_version
       
   459         * @param aItem Script line containing parameters.
       
   460         * @return Symbian OS error code.
       
   461         */
       
   462      	virtual TInt TestServiceIDL( CStifItemParser& aItem );
       
   463      	
       
   464      	/**
       
   465         * Test Case for Calling CSendingServiceInfo's ServiceProviderID functions
       
   466         * @since ?Series60_version
       
   467         * @param aItem Script line containing parameters.
       
   468         * @return Symbian OS error code.
       
   469         */
       
   470      	virtual TInt TestServiceProviderIDL( CStifItemParser& aItem );
       
   471      	
       
   472      	/**
       
   473         * Test Case for Calling CSendingServiceInfo's ServiceCapabilities functions
       
   474         * @since ?Series60_version
       
   475         * @param aItem Script line containing parameters.
       
   476         * @return Symbian OS error code.
       
   477         */
       
   478      	virtual TInt TestServiceCapabilitiesL( CStifItemParser& aItem );
       
   479      	
       
   480         //ADD NEW METHOD DEC HERE
       
   481         //[TestMethods] - Do not remove
       
   482 
       
   483     public:     // Data
       
   484         // ?one_line_short_description_of_data
       
   485         //?data_declaration;
       
   486 
       
   487     protected:  // Data
       
   488         // ?one_line_short_description_of_data
       
   489         //?data_declaration;
       
   490 
       
   491     private:    // Data
       
   492     	//CMessageData memeber variable 
       
   493         CMessageData* iMessageData;	
       
   494         //Buffer to read and write from stream
       
   495         CBufBase* ibuffer;
       
   496         //CMessageAddress variable
       
   497         CMessageAddress* iMessageAddress;
       
   498         //Buffer to read and write from stream  
       
   499         CBufBase* iMsgAdrbuffer;
       
   500         //?data_declaration;
       
   501 
       
   502         // Reserved pointer for future extension
       
   503         //TAny* iReserved;
       
   504 
       
   505     public:     // Friend classes
       
   506         //?friend_class_declaration;
       
   507     protected:  // Friend classes
       
   508         //?friend_class_declaration;
       
   509     private:    // Friend classes
       
   510         //?friend_class_declaration;
       
   511 
       
   512     };
       
   513    
       
   514  
       
   515 
       
   516 #endif      // SendUIAPITest_H
       
   517 
       
   518 // End of File