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:    Interface for CseScheduler Client's Service class*

    15 */

    16 

    17 

    18 

    19 #ifndef __RCSESCHEDULERSERVICE_H__

    20 #define __RCSESCHEDULERSERVICE_H__

    21 

    22 // INCLUDES

    23 #include <ipvideo/RCseSchedulerServiceBase.h>   // Client common methods (open, close etc)

    24 

    25 // CONSTANTS

    26 // None.

    27 

    28 // MACROS

    29 // None.

    30 

    31 // DATA TYPES

    32 // None.

    33 

    34 // FUNCTION PROTOTYPES

    35 // None.

    36 

    37 // FORWARD DECLARATIONS

    38 class CCseScheduledProgram;

    39 

    40 // CLASS DECLARATION    

    41 /**

    42 *  General client api that manages service functionality.

    43 *

    44 *  @lib CseSchedulerClient.lib

    45 */

    46 class RCseSchedulerService : public RCseSchedulerServiceBase

    47     {

    48     public: // Constructors and destructor

    49         

    50         /**

    51         * Constructor.

    52         * @return None.

    53         */

    54         RCseSchedulerService();

    55 

    56         /**

    57         * Destructor.

    58         * @return None.

    59         */

    60         virtual ~RCseSchedulerService();

    61     

    62     public: // New methods

    63     	/**

    64         * Adds given schedule to Common Scheduling Engine database. After the call is

    65         * completed, the parameter contains the DB identifier of the schedule.

    66         * @param    aData   Schedule to be added to database.        

    67         */

    68         void AddScheduleL( CCseScheduledProgram& aData ) const;

    69         

    70         /**

    71         * Removes schedule from database.

    72         * @param    aDbIdentifier  Database identifier of the schedule to be removed.

    73         * @return Generic symbian error code.

    74         */

    75         void RemoveScheduleL( const TUint32 aDbIdentifier ) const;

    76         

    77         /**

    78         * Gets schedule from database.

    79         * @param    aDbIdentifier   Database identifier of the schedule that is wanted

    80         *                           from the database

    81         * @param    aProg           Pointer where this scheduled program is get.

    82         * @return   Generic symbian error codes.

    83         */

    84         void GetScheduleL( const TUint32 aDbIdentifier,

    85         				  CCseScheduledProgram* aProg ) const;

    86 

    87 		/**

    88 		* Get list of scheduled events from the scheduling engine based on given UID.

    89 		* @param    aAppUid     Application UID.

    90 		* @param    aArray      On return contains items from the database.

    91 		* @return   Generic symbian error code.

    92 		*/

    93 		void GetSchedulesL( const TInt32 aAppUid, 

    94 							RPointerArray<CCseScheduledProgram>& aArray ) const;

    95 

    96 		/**

    97 		* Get overlapping schedule (if any) from the scheduling engine.

    98 		* Uses schedule type, start and end times to find overalapping 

    99 		* schedules from the Commone Scheduling Engine database.

   100 		* @param    aProgram        Schedule to used for finding overlapping schedules.

   101 		* @param    aResultArray    On return, contains array of overlapping 

   102 		* 		                    schedules, empty if none found.

   103 		* @return Generic symbian error code.

   104 		*/

   105 		void GetOverlappingSchedulesL( CCseScheduledProgram& aProgram, 

   106 					RPointerArray<CCseScheduledProgram>& aResultArray );

   107 		

   108 		/**

   109 		* Get list of scheduled events from the scheduling engine based on given plugin UID.

   110 		* @param    aPluginUid     Plugin UID.

   111 		* @param    aArray      On return contains items from the database.

   112 		* @return   Generic symbian error code.

   113 		*/			

   114 		void GetSchedulesByPluginUidL( const TInt32 aPluginUid, 

   115 					                   RPointerArray<CCseScheduledProgram>& aArray ) const;

   116         

   117         /**

   118 		* Get list of scheduled events from the scheduling engine based on given schedule type.

   119 		* @param    aType       Schedule type.

   120 		* @param    aArray      On return contains items from the database.

   121 		* @return   Generic symbian error code.

   122 		*/			

   123         void GetSchedulesByTypeL( const TInt32 aType, 

   124 			                      RPointerArray<CCseScheduledProgram>& aArray ) const;

   125         

   126         /**

   127 		* Get list of scheduled events from the scheduling engine between given timeframe.

   128 		* @param    aBeginning  Beginning of the timeframe.

   129 		* @param    aEnd        End of the timeframe.

   130 		* @param    aArray      On return contains items from the database.

   131 		* @return   Generic symbian error code.

   132 		*/						                    

   133         void GetSchedulesByTimeL( const TTime& aBegining, 

   134                                   const TTime& aEnd,

   135 			                      RPointerArray<CCseScheduledProgram>& aArray ) const;

   136     };

   137 

   138 #endif //__RCSESCHEDULERSERVICE_H__

   139 

   140 // End of File

   141