omadrm/drmplugins/drmromtm/client/inc/RoMtmCli.h
changeset 0 95b198f216e5
equal deleted inserted replaced
-1:000000000000 0:95b198f216e5
       
     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:  Declaration of Rights Object Client side MTM
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef RIGHTSOBJECTMTMCLIENT_H
       
    21 #define RIGHTSOBJECTMTMCLIENT_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 #include <mtclbase.h>
       
    26 // CONSTANTS
       
    27 // MACROS
       
    28 // DATA TYPES
       
    29 // FUNCTION PROTOTYPES
       
    30 // FORWARD DECLARATIONS
       
    31 class CRoMessageHeader;
       
    32 
       
    33 // CLASS DECLARATION
       
    34 /**
       
    35 *	CRightsObjectMtmClient
       
    36 *  
       
    37 *  @lib RoMtmCli.lib
       
    38 *  @since 2.5
       
    39 */
       
    40 class CRightsObjectMtmClient : public CBaseMtm
       
    41     {
       
    42     public:  // Constructors and destructor
       
    43         
       
    44         /**
       
    45         * Two-phased constructor.
       
    46         */
       
    47         IMPORT_C static CRightsObjectMtmClient* NewL(
       
    48 					CRegisteredMtmDll& aRegisteredMtmDll , 
       
    49 					CMsvSession& aMsvSession );
       
    50         
       
    51 		/**
       
    52         * Destructor.
       
    53         */
       
    54          ~CRightsObjectMtmClient();
       
    55 
       
    56    	public: // Functions from base classes
       
    57 
       
    58 		/*************************************
       
    59 		*
       
    60 		*		from CBaseMtm
       
    61 		*
       
    62 		**************************************/
       
    63 
       
    64 
       
    65 		// Store and restore entry data 
       
    66 		/**
       
    67         * SaveMessageL
       
    68         * @since 2.5
       
    69         */
       
    70 		void SaveMessageL(); 
       
    71 
       
    72 		/**
       
    73         * LoadMessageL
       
    74         * @since 2.5
       
    75         */
       
    76 		void LoadMessageL();
       
    77 
       
    78 		// Response message creation 
       
    79 
       
    80 		/**
       
    81         * ReplyL
       
    82         * @since 2.5
       
    83         * 
       
    84 		* Not supported
       
    85 		*
       
    86         */	
       
    87 		CMsvOperation* ReplyL  ( TMsvId aReplyEntryId , TMsvPartList aPartlist , TRequestStatus& aCompletionStatus );
       
    88 
       
    89 		/**
       
    90         * ForwardL
       
    91         * @since 2.5
       
    92         * 
       
    93 		* Not supported
       
    94 		*
       
    95         */
       
    96 		CMsvOperation* ForwardL( TMsvId aForwardEntryId , TMsvPartList aPartList , TRequestStatus& aCompletionStatus );
       
    97 
       
    98 		// Validation and search 
       
    99 		
       
   100 		/**
       
   101         * ValidateMessage
       
   102         * @since 2.5
       
   103         * 
       
   104 		* Not supported
       
   105 		*
       
   106         */	
       
   107 		TMsvPartList ValidateMessage( TUint aPartList );
       
   108 		
       
   109 		/**
       
   110         * Find
       
   111         * @since 2.5
       
   112         * 
       
   113 		* Not supported
       
   114 		*
       
   115         */			
       
   116 		TMsvPartList Find( const TDesC& aTextToFind , TMsvPartList aPartList );
       
   117 
       
   118 		// Addresses are not used in this MTM
       
   119 		
       
   120 		/**
       
   121         * AddAddresseeL
       
   122         * @since 2.5
       
   123         * 
       
   124 		* Not supported
       
   125 		*
       
   126         */			
       
   127 		void AddAddresseeL( const TDesC& aRealAddress );
       
   128 		
       
   129 		/**
       
   130         * AddAddresseeL
       
   131         * @since 2.5
       
   132         * 
       
   133 		* Not supported
       
   134 		*
       
   135         */			
       
   136 		void AddAddresseeL( const TDesC& aRealAddress , const TDesC& aAlias );
       
   137 		
       
   138 		/**
       
   139         * RemoveAddressee
       
   140         * @since 2.5
       
   141         * 
       
   142 		* Not supported
       
   143 		*
       
   144         */			
       
   145 		void RemoveAddressee( TInt aIndex );
       
   146 
       
   147 		// MTM-specific functionality
       
   148 
       
   149 		/**
       
   150         * QueryCapability
       
   151         * @since 2.5
       
   152         * 
       
   153 		* @param aCapability UID of capability to be queried 
       
   154 		* @param aResponse Response value. The format of the response varies according to the capability
       
   155 		*
       
   156 		* @return KErrNone: aFunctionId is a recognised value and a response is returned KErrNotSupported: aFunctionId is not a recognised value 
       
   157         */	
       
   158 		TInt QueryCapability( TUid aCapability , TInt& aResponse );
       
   159 
       
   160 		/**
       
   161         * InvokeSyncFunctionL
       
   162         * @since 2.5
       
   163         * 
       
   164 		* Not supported
       
   165 		*
       
   166         */	
       
   167 		void InvokeSyncFunctionL( TInt aFunctionId , const CMsvEntrySelection& aSelection , TDes8& aParameter );
       
   168 		
       
   169 		/**
       
   170         * InvokeAsyncFunctionL
       
   171         * @since 2.5
       
   172         * 
       
   173 		* Not supported
       
   174 		*
       
   175         */			
       
   176 		CMsvOperation* InvokeAsyncFunctionL( TInt aFunctionId , const CMsvEntrySelection& aSelection , TDes8& aParameter , TRequestStatus& aCompletionStatus );
       
   177 		
       
   178 	protected:  
       
   179 
       
   180 		CRightsObjectMtmClient( CRegisteredMtmDll& aRegisteredMtmDll , CMsvSession& aMsvSession );
       
   181 
       
   182 		void ConstructL();        
       
   183 
       
   184 		/*************************************
       
   185 		*
       
   186 		*		from CBaseMtm
       
   187 		*
       
   188 		**************************************/
       
   189 		void ContextEntrySwitched(); 
       
   190 
       
   191     protected:  // Functions from base classes
       
   192     private:
       
   193 //		void SetEntryDetailsL();
       
   194 //		void SetEntryDescriptionL();
       
   195 	public:     // Data
       
   196     protected:  // Data
       
   197     private:    // Data
       
   198 //		CRoMessageHeader* iHeader;
       
   199     public:     // Friend classes
       
   200     protected:  // Friend classes
       
   201     private:    // Friend classes
       
   202     };
       
   203 
       
   204 
       
   205 
       
   206 #endif      // RIGHTSOBJECTMTMCLIENT_H
       
   207             
       
   208 // End of File