1 /*

     2 * Copyright (c) 2006 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 the License "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 to inform common scheduling engine when plugin is*

    15 */

    16 

    17 

    18 

    19 

    20 #ifndef __MCSEPLUGINCONTROLLEROBSERVER_H__

    21 #define __MCSEPLUGINCONTROLLEROBSERVER_H__

    22 

    23 class CCseSchedulerPluginControllerBase;

    24 

    25 // CLASS DECLARATION

    26 /**

    27 * MCsePluginControllerObserver

    28 * This class offers plugin controller some of the engine's utilities.

    29 */

    30 class MCsePluginControllerObserver

    31     {

    32     public: // New functions                

    33         /**

    34         * Method to inform succesfully completed schedules.

    35         * @param    aDbIdentifier   Identifier of the schedule that has

    36         *                           completed.

    37         */

    38         virtual void ScheduleCompletedSuccesfullyL( const TUint32 aDbIdentifier ) = 0;

    39         

    40         /**

    41         * Method to inform failed schedules.

    42         * @param    aDbIdentifier   Identifier of the schedule that has

    43         *                           completed.

    44         */

    45         virtual void ScheduleCompletedWithErrorL( const TUint32 aDbIdentifier,

    46                                                   TUint32 aErrorCode ) = 0;

    47         

    48         /**

    49         * Orders engine to increase run count of given shedule.

    50         * @param    aDbIdentifier   Identifier of the schedule who's run

    51         *                           needs to be incremented.

    52         */                                                 

    53         virtual void IncreaseScheduleRunCountL( const TUint32 aDbIdentifier ) = 0;

    54         

    55         /**

    56         * Asks from engine if given schedule can be run

    57         * @param    aDbIdentifier   Identifier of the schedule to be checked.

    58         * @return boolean value representing if schedule can be run or not.

    59         */

    60         virtual TBool IsAllowedToRun( const TUint32 aDbIdentifier ) = 0;

    61         

    62         /**

    63         * Reports not valid schedule to engine (schedule cannot be run anymore).

    64         * @param    aDbIdentifier   Reported schedules identifier.        

    65         */

    66         virtual void ScheduleNotValid( const TUint32 aDbIdentifier ) = 0;

    67         

    68         /**

    69         * Requests rescheduling for plugin controllers        

    70         */

    71         virtual void RequestReschedule( ) = 0;

    72         

    73         /**

    74          * Signals when plugin controller clearing is done.        

    75          */

    76         virtual void ClearingDone( ) = 0;

    77     };

    78 

    79 #endif // __MCSEPLUGINCONTROLLEROBSERVER_H__

    80 

    81 // End of File