1 /*

     2 * Copyright (c) 2004 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:  Observer interface to listen reactive authorization transaction completion.

    15 *

    16 */

    17 

    18 #ifndef __MPENGREACTAUTHTRANSACTIONOBSERVER_H

    19 #define __MPENGREACTAUTHTRANSACTIONOBSERVER_H

    20 

    21 //  INCLUDES

    22 #include <E32Std.h>

    23 

    24 

    25 // FORWARD DECLARATIONS

    26 class CPEngReactAuthTransaction;

    27 class MPEngTransactionStatus2;

    28 

    29 

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34  * Observer interface to receive reactive authorization

    35  * transaction completion events.

    36  *

    37  * @since 3.0

    38  */

    39 class MPEngReactAuthTransactionObserver

    40     {

    41     public: //Observer methods

    42 

    43 

    44         /**

    45          * Transaction complete handler.

    46          *

    47          * Called by CPEngReactAuthTransaction to handle reactive authorization

    48          * transaction complete. If this method leaves, error code is

    49          * reported back to HandleReactAuthTransactionError().

    50          *

    51          * @since 3.0

    52          * @param aStatus Transaction status container holding result from

    53          *        transaction. Container ownership remains on the notfier.

    54          * @param aTransaction The transaction object where notification

    55          *        is coming from. No ownership transferred.

    56          * @param aTransactionOperation ID of the completed transaction.

    57          *        Transaction operation IDs are listed in

    58          *        PEngPresenceEngineConsts2.h TPEngTransactionOperation

    59          *        enumeration. Client can use transaction ID to figure

    60          *        out what operation completed.

    61          */

    62         virtual void HandleReactAuthTransactionCompleteL(

    63             MPEngTransactionStatus2& aStatus,

    64             CPEngReactAuthTransaction& aTransaction,

    65             TInt aTransactionOperation ) = 0;

    66 

    67 

    68         /**

    69          * Failure handler.

    70          *

    71          * Called to handle leave errors from

    72          * HandleReactAuthTransactionCompleteL().

    73          *

    74          * @since 3.0

    75          * @param aError The leave error from transaction complete handling.

    76          * @param aTransaction The transaction object which event

    77          *        handling failed.

    78          * @param aTransactionOperation ID of the transaction operation.

    79          *        which event handling failed. Transaction operation

    80          *        IDs are listed in PEngPresenceEngineConsts2.h

    81          *        TPEngTransactionOperation enumeration.

    82          */

    83         virtual void HandleReactAuthTransactionError(

    84             TInt aError,

    85             CPEngReactAuthTransaction& aTransaction,

    86             TInt aTransactionOperation ) = 0;

    87 

    88 

    89 

    90     private: //Extensions

    91 

    92         /**

    93          * Reserved virtual table slots for future use.

    94          * Do not implement this.

    95          *

    96          * @since 3.0

    97          */

    98         virtual TInt ReactAuthTransactionReserved() {

    99             return KErrNotSupported;

   100             }

   101 

   102 

   103 

   104     protected:  //Destructor

   105 

   106         /**

   107          * Protected destructor.

   108          * Observers can't be destroyed via this interface.

   109          */

   110         virtual ~MPEngReactAuthTransactionObserver() { }

   111 

   112     };

   113 

   114 

   115 

   116 #endif //__MPENGREACTAUTHTRANSACTIONOBSERVER_H

   117 

   118 

   119 //End of file

   120 

   121 

   122 

   123