telephonyserverplugins/simatktsy/inc/CSatNotifySetUpEventList.h
changeset 0 3553901f7fa8
equal deleted inserted replaced
-1:000000000000 0:3553901f7fa8
       
     1 /*
       
     2 * Copyright (c) 2005-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:
       
    15 * Name        : CSatNotifySetUpEventList.h
       
    16 * Part of     : Common SIM ATK TSY / commonsimatktsy
       
    17 * Specific notifications class
       
    18 * Version     : 1.0
       
    19 *
       
    20 */
       
    21 
       
    22 
       
    23 
       
    24 #ifndef CSATNOTIFYSETUPEVENTLIST_H
       
    25 #define CSATNOTIFYSETUPEVENTLIST_H
       
    26 
       
    27 
       
    28 //  INCLUDES
       
    29 #include <etelsat.h>
       
    30 #include "MSatNotificationsBase.h"
       
    31 
       
    32 // FORWARD DECLARATIONS
       
    33 class CSatDataPackage;
       
    34 class CSatNotificationsTsy;
       
    35 
       
    36 /**
       
    37 * DESCRIPTION
       
    38 * SAT Notify set up event list notification class.
       
    39 * Created when client requests to be notified if a request (of any other 
       
    40 * existing client) has been modified by call control.
       
    41 * @lib Commonsimatktsy
       
    42 * @since 3.1
       
    43 */
       
    44 NONSHARABLE_CLASS ( CSatNotifySetUpEventList ) : public CBase,
       
    45                            public MSatNotificationsBase
       
    46     {
       
    47     public:   // Constructors and destructor
       
    48         
       
    49         /**
       
    50         * Two-phased constructor.
       
    51         * @param aNotificationsTsy: Pointer to NotificationsTsy
       
    52         * return CSatNotifySetUpEventList*: created object 
       
    53         */
       
    54         static CSatNotifySetUpEventList* NewL( 
       
    55         	CSatNotificationsTsy* aNotificationsTsy );
       
    56 
       
    57         /**
       
    58         * C++ Destructor.
       
    59         */
       
    60         ~CSatNotifySetUpEventList();
       
    61 
       
    62 	private:
       
    63         /**
       
    64         * By default C++ constructor is private.
       
    65         * @param aNotificationsTsy: Pointer to NotificationsTsy
       
    66         * @return None
       
    67         */
       
    68         CSatNotifySetUpEventList( CSatNotificationsTsy* aNotificationsTsy );
       
    69 
       
    70         /**
       
    71         * Class attributes are created in ConstructL. 
       
    72         * @param None
       
    73         * @return None
       
    74         */
       
    75         void ConstructL();
       
    76 
       
    77     public: // Functions from base classes
       
    78 
       
    79         /**
       
    80         * Set up event list Notification request received from client
       
    81         * @param aTsyReqHandle: request handle from ETel
       
    82         * @param aPackage: Packed data
       
    83         * @return KErrNone
       
    84         */
       
    85         TInt Notify( const TTsyReqHandle aTsyReqHandle,
       
    86             const TDataPackage& aPackage );
       
    87 
       
    88         /**
       
    89         * Cancels notification request for SetUpEventList.
       
    90         * @param aReqHandle notify request handle
       
    91         * @return KErrNone
       
    92         */
       
    93         TInt CancelNotification( const TTsyReqHandle aReqHandle );
       
    94                  
       
    95         /**
       
    96         * Completes SetUpEventList message to client
       
    97         * @param aDataPackage: Packaged return data
       
    98         * @param aErrorCode: Possible error code
       
    99         * @return KErrNone/ KErrCorrupt
       
   100         */
       
   101         TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode );
       
   102 
       
   103         /**
       
   104         * From CSatNotificationsBase handles Set up event list terminal response 
       
   105         * coming from client.
       
   106         * @param aRsp: Response structure
       
   107         * @return KErrNone/ KErrCorrupt
       
   108         */
       
   109         TInt TerminalResponseL( TDes8* aRsp );
       
   110    
       
   111 	public: // New functions     
       
   112         /**
       
   113         * Create notification specific terminal response data
       
   114         * @param aPCmdNumber: Proactive command number
       
   115         * @param aGeneralResult: Result of the proactive command
       
   116         * @param aAdditionalInfo: Additional info for terminal response
       
   117         * @return Success/Failure value
       
   118         */
       
   119         TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult,
       
   120             					 TDesC16& aAdditionalInfo );  
       
   121 
       
   122     private: // Data
       
   123         
       
   124         // Notify Set Up Event List struct. Package allocated
       
   125         // in this class and received from ETel
       
   126         RSat::TSetUpEventListV1Pckg* iSetUpEventListV1Pckg;
       
   127         // Event list
       
   128         TUint iEvents;
       
   129         // Pointer to the notifications tsy class
       
   130         CSatNotificationsTsy* iNotificationsTsy;
       
   131     };
       
   132 
       
   133 
       
   134 #endif // CSATNOTIFYSETUPEVENTLIST_H