1 

     2 (object Petal

     3     version    	40)

     4 

     5 (object Design "Logical View"

     6     is_unit    	TRUE

     7     is_loaded  	TRUE

     8     file_name  	"D:\\schsvr\\DESIGN\\Model.mdl"

     9     quid       	"3607CDBF00DB"

    10     defaults   	(object defaults

    11 	rightMargin 	0.250000

    12 	leftMargin 	0.250000

    13 	topMargin  	0.250000

    14 	bottomMargin 	0.500000

    15 	pageOverlap 	0.250000

    16 	clipIconLabels 	TRUE

    17 	autoResize 	FALSE

    18 	snapToGrid 	TRUE

    19 	gridX      	16

    20 	gridY      	16

    21 	defaultFont 	(object Font

    22 	    size       	10

    23 	    face       	"Arial"

    24 	    bold       	FALSE

    25 	    italics    	FALSE

    26 	    underline  	FALSE

    27 	    strike     	FALSE

    28 	    color      	0

    29 	    default_color 	TRUE)

    30 	showMessageNum 	3

    31 	showClassOfObject 	TRUE

    32 	notation   	"Unified")

    33     root_usecase_package 	(object Class_Category "Use Case View"

    34 	quid       	"34B4B32D038B"

    35 	exportControl 	"Public"

    36 	global     	TRUE

    37 	logical_models 	(list unit_reference_list)

    38 	logical_presentations 	(list unit_reference_list

    39 	    (object UseCaseDiagram "Main"

    40 		quid       	"358F97CC012F"

    41 		title      	"Main"

    42 		zoom       	100

    43 		max_height 	28350

    44 		max_width  	21600

    45 		origin_x   	0

    46 		origin_y   	0

    47 		items      	(list diagram_item_list))))

    48     root_category 	(object Class_Category "Logical View"

    49 	quid       	"34B4B32D038A"

    50 	exportControl 	"Public"

    51 	global     	TRUE

    52 	subsystem  	"Component View"

    53 	quidu      	"34B4B32D038C"

    54 	logical_models 	(list unit_reference_list

    55 	    (object Class "CServer"

    56 		quid       	"34D1C70C010E"

    57 		abstract   	TRUE

    58 		operations 	(list Operations

    59 		    (object Operation "RunL"

    60 			quid       	"34D1C726002F"

    61 			concurrency 	"Sequential"

    62 			opExportControl 	"Public"

    63 			uid        	0)

    64 		    (object Operation "Start"

    65 			quid       	"34D1C73102B6"

    66 			concurrency 	"Sequential"

    67 			opExportControl 	"Public"

    68 			uid        	0)))

    69 	    (object Class "CSession"

    70 		quid       	"34D1C70C0168"

    71 		abstract   	TRUE)

    72 	    (object Class "CSchSession"

    73 		quid       	"34D1C70C014A"

    74 		documentation 	

    75 |

    76 |The session class, server-side. Mostly just unpacks RMessages and forwards commands on to the Task Scheduler instance.

    77 |Initialised on creation with the instance of CTaskScheduler. 

    78 |Its iClient member is initialised to NULL. Once the client using the session has registered, its iClient member is set to point to that client, and any tasks scheduled by that client during the session belong to that iClient.

    79 		

    80 		superclasses 	(list inheritance_relationship_list

    81 		    (object Inheritance_Relationship

    82 			quid       	"34D1C70C014B"

    83 			supplier   	"CSession"

    84 			quidu      	"34D1C70C0168"))

    85 		used_nodes 	(list uses_relationship_list

    86 		    (object Uses_Relationship

    87 			quid       	"352B456F0032"

    88 			label      	"iSchedules"

    89 			supplier   	"CSchedule"

    90 			quidu      	"34D1CB1C0073"

    91 			supplier_cardinality 	(value cardinality "0..n")

    92 			client_cardinality 	(value cardinality "1..1")))

    93 		operations 	(list Operations

    94 		    (object Operation "ServiceL"

    95 			quid       	"34D1C74003BB"

    96 			concurrency 	"Sequential"

    97 			opExportControl 	"Public"

    98 			uid        	0)))

    99 	    (object Class "CSchServer"

   100 		quid       	"34D1C70C0110"

   101 		documentation 	

   102 |

   103 |The server class. Owns (directly) all session instances, and the one and only instance of CTaskScheduler. 

   104 |Owns (indirectly) everything else.

   105 		

   106 		superclasses 	(list inheritance_relationship_list

   107 		    (object Inheritance_Relationship

   108 			quid       	"34D1C70C010F"

   109 			supplier   	"CServer"

   110 			quidu      	"34D1C70C010E")))

   111 	    (object Class "CTaskScheduler"

   112 		quid       	"34D1C70C0186"

   113 		documentation 	

   114 |- Owns all the other scheduler objects.

   115 |- Provides an interface for creating, deleting, editing & naming schedules

   116 |- Provides an interface for registering users by creating new client proxies

   117 |- Provides an interface for scheduling tasks

   118 |- Informs schedules when they are due, and updates them accordingly

   119 |- Executes clients when appropriate

   120 |- Ensures that any persistent schedules are added to the persistent backup store through its iBackup member; so all is not lost in case of server death

   121 |- Maintains schedule instances in TWO lists:

   122 |       -the first, 'iSchedules' is a list of all the schedules defined and is an owning list.

   123 |       -the second, iPending, is a list of all schedules which are waiting to go off (i.e. those schedules which have tasks scheduled and are not disabled. This list is ordered by the due time for the schedules. The scheduler maintains this list and sets the timer's time to be the due time of the first schedule in the list.

   124 |

   125 |- Whenever the server starts, it asks its iBackup member to restore its schedules from backup. 

   126 |If the backup file is missing or corrupt it asks the iBackup to create a new, empty one.

   127 |Subsequently, whenever schedules are added, deleted or edited the iBackup member is asked to back up the store to keep it in sync

   128 |

   129 |N.B. I would like to eliminate this class, as soon as I get the time. This won't affect clients at all but will improve the design.

   130 		

   131 		fields     	(list has_relationship_list

   132 		    (object Has_Relationship

   133 			quid       	"34D1C70C0187"

   134 			label      	"iTimer"

   135 			supplier   	"CServiceTimer"

   136 			quidu      	"34D1CB1C0005"

   137 			supplier_cardinality 	(value cardinality "1..1")

   138 			client_cardinality 	(value cardinality "1..1")))

   139 		operations 	(list Operations

   140 		    (object Operation "ScheduleTaskL"

   141 			quid       	"34D1C70C018A"

   142 			parameters 	(list Parameters

   143 			    (object Parameter "aUser"

   144 				type       	"TUid")

   145 			    (object Parameter "aItem"

   146 				type       	"TInt")

   147 			    (object Parameter "aAction"

   148 				type       	"TItemAction")

   149 			    (object Parameter "aSchedule"

   150 				type       	"TScheduleInfo"))

   151 			result     	"void"

   152 			concurrency 	"Sequential"

   153 			opExportControl 	"Public"

   154 			uid        	0)

   155 		    (object Operation "DeleteTaskL"

   156 			quid       	"34D1C70C018F"

   157 			parameters 	(list Parameters

   158 			    (object Parameter "aUser"

   159 				type       	"TUid")

   160 			    (object Parameter "aItem"

   161 				type       	"TInt"))

   162 			result     	"return"

   163 			concurrency 	"Sequential"

   164 			opExportControl 	"Public"

   165 			uid        	0)

   166 		    (object Operation "NewScheduleL"

   167 			quid       	"34D1C70C0192"

   168 			parameters 	(list Parameters

   169 			    (object Parameter "aUser"

   170 				type       	"TUid"))

   171 			result     	"return"

   172 			concurrency 	"Sequential"

   173 			opExportControl 	"Public"

   174 			uid        	0)

   175 		    (object Operation "DeleteScheduleL"

   176 			quid       	"34D1C70C0194"

   177 			parameters 	(list Parameters

   178 			    (object Parameter "aUser"

   179 				type       	"TUid"))

   180 			result     	"return"

   181 			concurrency 	"Sequential"

   182 			opExportControl 	"Public"

   183 			uid        	0)

   184 		    (object Operation "RegisterClientL"

   185 			quid       	"34D1C70C0196"

   186 			concurrency 	"Sequential"

   187 			opExportControl 	"Public"

   188 			uid        	0)

   189 		    (object Operation "EditScheduleL"

   190 			quid       	"34D1C70C0197"

   191 			concurrency 	"Sequential"

   192 			opExportControl 	"Public"

   193 			uid        	0)

   194 		    (object Operation "DueTaskNotify"

   195 			quid       	"352B45320229"

   196 			concurrency 	"Sequential"

   197 			opExportControl 	"Public"

   198 			uid        	0)

   199 		    (object Operation "ExecuteClients"

   200 			quid       	"352B453D0095"

   201 			concurrency 	"Sequential"

   202 			opExportControl 	"Public"

   203 			uid        	0))

   204 		class_attributes 	(list class_attribute_list

   205 		    (object ClassAttribute "iNotifier"

   206 			quid       	"3587EEDB01FD"

   207 			type       	"CEnvironmentChangeNotifier")

   208 		    (object ClassAttribute "iBackup"

   209 			quid       	"3587F07A0380"

   210 			type       	"TScheduleBackup"))

   211 		statediagram 	(object State_Diagram ""

   212 		    quid       	"3587F1420279"

   213 		    title      	""

   214 		    zoom       	100

   215 		    max_height 	28350

   216 		    max_width  	21600

   217 		    origin_x   	0

   218 		    origin_y   	0

   219 		    items      	(list diagram_item_list)))

   220 	    (object Class "CClientProxy"

   221 		quid       	"34D1CB1B03A7"

   222 		documentation 	

   223 |

   224 |This class encapsulates the information needed to execute a set of tasks, and owns the tasks associated with it.

   225 |

   226 |An instance of it gets created when a client registers, and is initialized with the name of the executing program, and its priority: if 2 clients have different priorities, the one with the higher priority gets to execute all its tasks before the low-priority one gets to execute any.

   227 |When it's told to execute, it:

   228 | - saves all its due tasks to a file

   229 | - creates a task executor, initializing it with the name of the executing program and the name of the file in which it's saved the tasks

   230 | - tells it to execute the tasks

   231 | - deletes any of the tasks which don't repeat  

   232 |

   233 |It is reference-counted: it is deleted when:

   234 |          - there are no open sessions which have a pointer to it

   235 |AND  - there are no pending tasks belonging to it  

   236 		

   237 		used_nodes 	(list uses_relationship_list

   238 		    (object Uses_Relationship

   239 			quid       	"34D1CB1B03A8"

   240 			label      	"iSchedules"

   241 			supplier   	"TScheduleEntry"

   242 			quidu      	"34D1CB1C0091"

   243 			supplier_cardinality 	(value cardinality "0..n")

   244 			client_cardinality 	(value cardinality "1..1"))

   245 		    (object Uses_Relationship

   246 			quid       	"3587DC1100C0"

   247 			supplier   	"CTaskExecutor"

   248 			quidu      	"3587DB8B0352"))

   249 		operations 	(list Operations

   250 		    (object Operation "Execute()"

   251 			quid       	"34FAE9140125"

   252 			concurrency 	"Sequential"

   253 			opExportControl 	"Public"

   254 			uid        	0))

   255 		class_attributes 	(list class_attribute_list

   256 		    (object ClassAttribute "iTaskExecutor"

   257 			quid       	"34D1CB1B03B2"

   258 			type       	"TFileName")

   259 		    (object ClassAttribute "iClientPriority"

   260 			quid       	"34FAE57802F3"

   261 			type       	"TInt"

   262 			exportControl 	"Public")

   263 		    (object ClassAttribute "iUsers"

   264 			quid       	"3588DFB30261"

   265 			type       	"TInt")))

   266 	    (object Class "CTimer"

   267 		quid       	"34D1CB1C0023")

   268 	    (object Class "CServiceTimer"

   269 		quid       	"34D1CB1C0005"

   270 		superclasses 	(list inheritance_relationship_list

   271 		    (object Inheritance_Relationship

   272 			quid       	"34D1CB1C0006"

   273 			supplier   	"CTimer"

   274 			quidu      	"34D1CB1C0023"))

   275 		operations 	(list Operations

   276 		    (object Operation "SetDueTime"

   277 			quid       	"34D1CB1C0007"

   278 			parameters 	(list Parameters

   279 			    (object Parameter "aNewTime"

   280 				type       	"TTime"))

   281 			result     	"return"

   282 			concurrency 	"Sequential"

   283 			opExportControl 	"Public"

   284 			uid        	0)

   285 		    (object Operation "DueTime"

   286 			quid       	"34D1CB1C000F"

   287 			result     	"TTime"

   288 			concurrency 	"Sequential"

   289 			opExportControl 	"Public"

   290 			uid        	0))

   291 		class_attributes 	(list class_attribute_list

   292 		    (object ClassAttribute "iDueTime"

   293 			quid       	"34D1CB1C0010"

   294 			type       	"TTime")

   295 		    (object ClassAttribute "iCallback"

   296 			quid       	"34D1CB1C0011"

   297 			type       	"TCallback")))

   298 	    (object Class "CSchedule"

   299 		quid       	"34D1CB1C0073"

   300 		documentation 	

   301 |

   302 |This class is responsible for knowing what time it's due. 

   303 |

   304 |It is defined essentially by an ordered list of one or more TScheduleEntry instances, each of which will return their own next due time when asked. 

   305 |

   306 |It also has zero or more tasks (TScheduledTask). When it is due, all its tasks are due and it tells them this. 

   307 |

   308 |It has 2 flags of type TBool:

   309 |    - iPersists: if a schedule persists, it hangs around whether it has got any tasks of not. If it doesn't, it gets deleted as soon as all its tasks are deleted.

   310 |   - iEnabled: if a schedule is disabled it just does nothing, whether it has tasks or not, until it is enabled again. 

   311 |

   312 		

   313 		fields     	(list has_relationship_list

   314 		    (object Has_Relationship

   315 			quid       	"34D1CB1C007D"

   316 			label      	"iEntries"

   317 			supplier   	"TScheduleEntry"

   318 			quidu      	"34D1CB1C0091"

   319 			exportControl 	"Private"

   320 			supplier_cardinality 	(value cardinality "1..1")

   321 			client_cardinality 	(value cardinality "1..1"))

   322 		    (object Has_Relationship

   323 			quid       	"352B481E0207"

   324 			label      	"iTasks"

   325 			supplier   	"TScheduledTask"

   326 			quidu      	"34D1CCE902E3"

   327 			supplier_cardinality 	(value cardinality "0..n")

   328 			client_cardinality 	(value cardinality "1..1")))

   329 		operations 	(list Operations

   330 		    (object Operation "AddEntry"

   331 			quid       	"34D1CB7503BA"

   332 			concurrency 	"Sequential"

   333 			opExportControl 	"Public"

   334 			uid        	0)

   335 		    (object Operation "RemoveEntry"

   336 			quid       	"34D1CB7B035F"

   337 			concurrency 	"Sequential"

   338 			opExportControl 	"Public"

   339 			uid        	0)

   340 		    (object Operation "AddTask"

   341 			quid       	"34D991F00386"

   342 			concurrency 	"Sequential"

   343 			opExportControl 	"Public"

   344 			uid        	0)

   345 		    (object Operation "DueTime"

   346 			quid       	"34D9922800FC"

   347 			result     	"TTime"

   348 			concurrency 	"Sequential"

   349 			opExportControl 	"Public"

   350 			uid        	0)

   351 		    (object Operation "FirstScheduledTime"

   352 			quid       	"34D9A92301AF"

   353 			concurrency 	"Sequential"

   354 			opExportControl 	"Public"

   355 			uid        	0)

   356 		    (object Operation "NextScheduledTime"

   357 			quid       	"34D9A9360185"

   358 			concurrency 	"Sequential"

   359 			opExportControl 	"Public"

   360 			uid        	0)

   361 		    (object Operation "NotifyClients"

   362 			quid       	"352B478A0055"

   363 			concurrency 	"Sequential"

   364 			opExportControl 	"Public"

   365 			uid        	0)

   366 		    (object Operation "NewL"

   367 			quid       	"3588EC8003CC"

   368 			parameters 	(list Parameters

   369 			    (object Parameter "aStore"

   370 				type       	"CFileStore")

   371 			    (object Parameter "aId"

   372 				type       	"TStreamId"))

   373 			result     	"CSchedule"

   374 			concurrency 	"Sequential"

   375 			opExportControl 	"Public"

   376 			uid        	0)

   377 		    (object Operation "StoreL"

   378 			quid       	"3588ECED0058"

   379 			parameters 	(list Parameters

   380 			    (object Parameter "aStore"

   381 				type       	"CFileStore"))

   382 			result     	"TStreamId"

   383 			concurrency 	"Sequential"

   384 			opExportControl 	"Public"

   385 			uid        	0)

   386 		    (object Operation "RestoreL"

   387 			quid       	"3588ED2E014B"

   388 			parameters 	(list Parameters

   389 			    (object Parameter "aStore"

   390 				type       	"CFileStore")

   391 			    (object Parameter "aId"

   392 				type       	"TStreamId"))

   393 			result     	"void"

   394 			concurrency 	"Sequential"

   395 			opExportControl 	"Public"

   396 			uid        	0)

   397 		    (object Operation "UpdateStoreL"

   398 			quid       	"3588ED490371"

   399 			parameters 	(list Parameters

   400 			    (object Parameter "aStore"

   401 				type       	"CPermanentFileStore")

   402 			    (object Parameter "aId"

   403 				type       	"TStreamId"))

   404 			result     	"void"

   405 			concurrency 	"Sequential"

   406 			opExportControl 	"Public"

   407 			uid        	0))

   408 		class_attributes 	(list class_attribute_list

   409 		    (object ClassAttribute "iDueTime"

   410 			quid       	"34D991DF01F1"

   411 			type       	"TTime")

   412 		    (object ClassAttribute "iPersists"

   413 			quid       	"3587F3B8001C"

   414 			type       	"TBool")

   415 		    (object ClassAttribute "iEnabled"

   416 			quid       	"3587F3BE0378"

   417 			type       	"TBool"

   418 			exportControl 	"Public")))

   419 	    (object Class "TScheduleEntry"

   420 		quid       	"34D1CB1C0091"

   421 		documentation 	

   422 |

   423 |TScheduleEntry knows what time it's next due after the time it gets passed. It is defined in terms of a start time and a time interval. So, when you pass it a time, if the time is before its start time it returns its start time, otherwise it adds its interval to its start time till the time it comes up with is after the time it got passed, and returns that.

   424 |

   425 |TScheduleEntry is abstract; it has 4 subclasses:

   426 |

   427 |TScheduleEntryHourly

   428 |TScheduleEntryDaily

   429 |TScheduleEntryMonthly

   430 |TScheduleEntryYearly

   431 |

   432 |The subclasses are necessary only because 'TTime operator + ' needs a concrete subclass of TTimeIntervalBase as the other operand. You specify which kind you want to create with the 'enum TIntervalType' parameter. This determines how the Interval member is interpreted,  i.e. if it's 1 and your interval type is EHourly then the actual interval is 1 hour; if it's EDaily then it's 1 day etc.

   433 |

   434 |

   435 		

   436 		abstract   	TRUE

   437 		operations 	(list Operations

   438 		    (object Operation "NextScheduledTime"

   439 			quid       	"34D1CB1C0092"

   440 			result     	"TTime"

   441 			concurrency 	"Sequential"

   442 			opExportControl 	"Public"

   443 			uid        	0)))

   444 	    (object Class "TScheduledTask"

   445 		quid       	"34D1CCE902E3"

   446 		documentation 	

   447 |

   448 |A TScheduledTask is a kind of placeholder for the real task, which is a CScheduledTask. It keeps a reference to the client proxy representing the client which scheduled it, and a reference to the real task. 

   449 |When it's due it tells both of them of this fact.

   450 		

   451 		operations 	(list Operations

   452 		    (object Operation "OnDue"

   453 			quid       	"3588DF80004B"

   454 			concurrency 	"Sequential"

   455 			opExportControl 	"Public"

   456 			uid        	0))

   457 		class_attributes 	(list class_attribute_list

   458 		    (object ClassAttribute "iClient"

   459 			quid       	"3587DADF025B"

   460 			type       	"CClientProxy")

   461 		    (object ClassAttribute "iTask"

   462 			quid       	"3587DAE40398"

   463 			type       	"CScheduledTask")))

   464 	    (object Class "CScheduledTask"

   465 		quid       	"3587D90700A3"

   466 		documentation 	

   467 |

   468 |This is where the real task data is kept:

   469 |  - name (TName), Id (TInt), data (HBufC),  how many times it repeats (TInt), when it's valid until (TTime), its priority

   470 |  - if it's repeat is specified as zero or less it repeats forever, or until it is explicitly deleted

   471 |  - tasks with high priority get executed before tasks with low priority

   472 |

   473 |It only needs to be a C-class 'cos of the HBufC* member.

   474 | 

   475 |

   476 |

   477 		

   478 		operations 	(list Operations

   479 		    (object Operation "OnDue"

   480 			quid       	"3588DF9B02C1"

   481 			concurrency 	"Sequential"

   482 			opExportControl 	"Public"

   483 			uid        	0))

   484 		class_attributes 	(list class_attribute_list

   485 		    (object ClassAttribute "iInfo"

   486 			quid       	"3587DB3E01B7"

   487 			type       	"TTaskInfo")

   488 		    (object ClassAttribute "iData"

   489 			quid       	"3587DB4803B0"

   490 			type       	"HBufC")))

   491 	    (object Class "TTaskInfo"

   492 		quid       	"3587DA760264"

   493 		documentation 	

   494 |

   495 |

   496 |This is passed to the scheduler when you schedule a task, and passed back again when you retireve it. 

   497 |You only need to specify iRepeat, iName and iPriority; the 	ID is filled in by the scheduler and can be retrieved and examined later.

   498 		

   499 		class_attributes 	(list class_attribute_list

   500 		    (object ClassAttribute "iRepeat"

   501 			quid       	"3588FADE0186"

   502 			type       	"TInt")

   503 		    (object ClassAttribute "iName"

   504 			quid       	"3588FAE5024E"

   505 			type       	"TName")

   506 		    (object ClassAttribute "iTaskId"

   507 			quid       	"3588FAE70356"

   508 			type       	"TInt")

   509 		    (object ClassAttribute "iPriority"

   510 			quid       	"3588FAED0386"

   511 			type       	"TInt")))

   512 	    (object Class "CTaskExecutor"

   513 		quid       	"3587DB8B0352"

   514 		documentation 	

   515 |

   516 |This class encapsulates the actual task executing business.

   517 |It's initialized with:

   518 | - the name of the executing program

   519 | - the name of the file where the task are kept

   520 |

   521 |When it's told to execute, it:

   522 | - creates a new process, keeping a handle to it

   523 | - logs on to the process                            

   524 | - runs the executing program in it

   525 |This program

   526 | - creates a new clean up stack

   527 | - opens the file with the tasks in it

   528 | - internalizes the tasks

   529 | - executes them how it likes

   530 |When the program (hence the process ) terminates, the CTaskExecutor runs. It examines the exit code of the dead process. If the program exited cleanly, and the exit code is KErrNone, the CTaskExecutor

   531 |just cleans up by closing the process, deleting the file with the tasks in it, and then deleting itself. Otherwise it does some error handling which is STILL NOT IMPLEMENTED, closes the process, deletes the task-file and then itself

   532 		

   533 		superclasses 	(list inheritance_relationship_list

   534 		    (object Inheritance_Relationship

   535 			quid       	"3587E0D20247"

   536 			supplier   	"CActive"

   537 			quidu      	"3587E0BF03E4"))

   538 		operations 	(list Operations

   539 		    (object Operation "ExecuteL"

   540 			quid       	"3587DB9C0144"

   541 			result     	"void"

   542 			concurrency 	"Sequential"

   543 			opExportControl 	"Public"

   544 			uid        	0))

   545 		class_attributes 	(list class_attribute_list

   546 		    (object ClassAttribute "iProcess"

   547 			quid       	"3587DBC7013C"

   548 			type       	"RProcess")

   549 		    (object ClassAttribute "iTaskFileName"

   550 			quid       	"3587DBCE0204"

   551 			type       	"TFileName")

   552 		    (object ClassAttribute "iClientFileName"

   553 			quid       	"3587DBE601EB"

   554 			type       	"TFileName")))

   555 	    (object Class "TScheduleBackup"

   556 		quid       	"3587DC9303DE"

   557 		documentation 	

   558 |

   559 |The TScheduleBackup class encapsulates management of the scheduler's backup store. The store has a path & name defined at compile-time, and accessible to the TScheduleBackup only. The store is a permanent file store whose root contains a CScheduleIndex. This is an array of (TInt ScheduleId, TStreamId).

   560 |So, when the BackupL(...) is called, this class:

   561 |- opens the store

   562 |- internalizes the index

   563 |- asks the index for the stream Id mapped to the Id of the schedule it's been passed

   564 |- does the appropriate action based on the TBackupAction enum (one of EAdd, EEdit, EDelete)

   565 |- updates the index, saves the index

   566 |If things  go wrong it calls Revert() on the store and then closes it, else it calls Commit() and then closes it. It keeps a count of the changes it's made, when it has made 5 changes it compacts the store.

   567 		

   568 		used_nodes 	(list uses_relationship_list

   569 		    (object Uses_Relationship

   570 			quid       	"3587E061038E"

   571 			supplier   	"CScheduleIndex"

   572 			quidu      	"3587DC95028C")

   573 		    (object Uses_Relationship

   574 			quid       	"3587E1C4008C"

   575 			supplier   	"CSchedule"

   576 			quidu      	"34D1CB1C0073")

   577 		    (object Uses_Relationship

   578 			quid       	"3588F2E200FB"

   579 			supplier   	"TScheduleIndexEntry"

   580 			quidu      	"3588F2210143"))

   581 		operations 	(list Operations

   582 		    (object Operation "BackupL()"

   583 			quid       	"3587E14C00A7"

   584 			concurrency 	"Sequential"

   585 			opExportControl 	"Public"

   586 			uid        	0)

   587 		    (object Operation "RestoreFromBackupL()"

   588 			quid       	"3587E153022E"

   589 			concurrency 	"Sequential"

   590 			opExportControl 	"Public"

   591 			uid        	0)

   592 		    (object Operation "BackupL"

   593 			quid       	"3588ED9F03A7"

   594 			parameters 	(list Parameters

   595 			    (object Parameter "aSchedule"

   596 				type       	"CSchedule")

   597 			    (object Parameter "TBackupAction aAction"))

   598 			result     	"void"

   599 			concurrency 	"Sequential"

   600 			opExportControl 	"Public"

   601 			uid        	0)

   602 		    (object Operation "CreateEmptyBackupL"

   603 			quid       	"3588EDFB0327"

   604 			result     	"void"

   605 			concurrency 	"Sequential"

   606 			opExportControl 	"Public"

   607 			uid        	0)

   608 		    (object Operation "RestoreFromBackupL"

   609 			quid       	"3588EE130191"

   610 			parameters 	(list Parameters

   611 			    (object Parameter "aSchedules"

   612 				type       	"TDblQue<CSchedule>"))

   613 			result     	"void"

   614 			concurrency 	"Sequential"

   615 			opExportControl 	"Public"

   616 			uid        	0)

   617 		    (object Operation "DoAddToBackupL"

   618 			quid       	"3588EE57035B"

   619 			parameters 	(list Parameters

   620 			    (object Parameter "aStore"

   621 				type       	"CPermanentFileStore")

   622 			    (object Parameter "aSchedule"

   623 				type       	"CSchedule"))

   624 			result     	"void"

   625 			concurrency 	"Sequential"

   626 			opExportControl 	"Public"

   627 			uid        	0)

   628 		    (object Operation "DoEditBackupL"

   629 			quid       	"3588EE59020A"

   630 			parameters 	(list Parameters

   631 			    (object Parameter "aStore"

   632 				type       	"CPermanentFileStore")

   633 			    (object Parameter "aSchedule"

   634 				type       	"CSchedule"))

   635 			result     	"void"

   636 			concurrency 	"Sequential"

   637 			opExportControl 	"Public"

   638 			uid        	0)

   639 		    (object Operation "DoRemoveFromBackupL"

   640 			quid       	"3588EE5B0054"

   641 			parameters 	(list Parameters

   642 			    (object Parameter "aStore"

   643 				type       	"CPermanentFileStore")

   644 			    (object Parameter "aScheduleId"

   645 				type       	"TInt"))

   646 			result     	"void"

   647 			concurrency 	"Sequential"

   648 			opExportControl 	"Public"

   649 			uid        	0)

   650 		    (object Operation "BackupName"

   651 			quid       	"3588EE600214"

   652 			parameters 	(list Parameters

   653 			    (object Parameter "aFileName"

   654 				type       	"TFileName"))

   655 			result     	"void"

   656 			concurrency 	"Sequential"

   657 			opExportControl 	"Public"

   658 			uid        	0)

   659 		    (object Operation "DoCompactL"

   660 			quid       	"3588EF2401F7"

   661 			result     	"void"

   662 			concurrency 	"Sequential"

   663 			opExportControl 	"Public"

   664 			uid        	0))

   665 		class_attributes 	(list class_attribute_list

   666 		    (object ClassAttribute "iChangesToStore"

   667 			quid       	"3588EF3403DB"

   668 			type       	"TInt")))

   669 	    (object Class "CScheduleIndex"

   670 		quid       	"3587DC95028C"

   671 		documentation 	

   672 |

   673 |Root stream of backup store.

   674 |Manages mapping of schedule Ids onto stream Ids.

   675 		

   676 		used_nodes 	(list uses_relationship_list

   677 		    (object Uses_Relationship

   678 			quid       	"3587E067001C"

   679 			supplier   	"CSchedule"

   680 			quidu      	"34D1CB1C0073"))

   681 		operations 	(list Operations

   682 		    (object Operation "UpdateStoreL"

   683 			quid       	"3588F1C000B7"

   684 			parameters 	(list Parameters

   685 			    (object Parameter "aStore"

   686 				type       	"CPermanentFileStore"))

   687 			result     	"void"

   688 			concurrency 	"Sequential"

   689 			opExportControl 	"Public"

   690 			uid        	0)

   691 		    (object Operation "RestoreL"

   692 			quid       	"3588F2000377"

   693 			parameters 	(list Parameters

   694 			    (object Parameter "aStore"

   695 				type       	"CFileStore"))

   696 			result     	"void"

   697 			concurrency 	"Sequential"

   698 			opExportControl 	"Public"

   699 			uid        	0)

   700 		    (object Operation "FindL"

   701 			quid       	"3588F2C1017F"

   702 			parameters 	(list Parameters

   703 			    (object Parameter "aScheduleId"

   704 				type       	"TInt"))

   705 			result     	"TScheduleIndexEntry"

   706 			concurrency 	"Sequential"

   707 			opExportControl 	"Public"

   708 			uid        	0)))

   709 	    (object Class "CActive"

   710 		quid       	"3587E0BF03E4")

   711 	    (object Class "CScheduleTimer"

   712 		quid       	"3587E1E90360"

   713 		documentation 	

   714 |

   715 |Derived from CTimer. Initialised to KMaxTTime; its time is subsequently set by the task scheduler.

   716 |When it runs, it tells the task scheduler.

   717 		)

   718 	    (object Class "CEnvironmentChangeNotifier"

   719 		quid       	"3587E6D100B3")

   720 	    (object Class "$UNNAMED$0"

   721 		quid       	"3587F7C900C4")

   722 	    (object Class "$UNNAMED$1"

   723 		quid       	"3587F7CA029C"

   724 		fields     	(list has_relationship_list

   725 		    (object Has_Relationship

   726 			quid       	"3587F7CD01B0"

   727 			supplier   	"$UNNAMED$0"

   728 			quidu      	"3587F7C900C4")))

   729 	    (object Class "TScheduleIndexEntry"

   730 		quid       	"3588F2210143"

   731 		operations 	(list Operations

   732 		    (object Operation "ExternalizeL"

   733 			quid       	"3588F23400F0"

   734 			concurrency 	"Sequential"

   735 			opExportControl 	"Public"

   736 			uid        	0)

   737 		    (object Operation "InternalizeL"

   738 			quid       	"3588F24002B0"

   739 			concurrency 	"Sequential"

   740 			opExportControl 	"Public"

   741 			uid        	0))

   742 		class_attributes 	(list class_attribute_list

   743 		    (object ClassAttribute "iStreamId"

   744 			quid       	"3588F24A01D8"

   745 			type       	"TStreamId")

   746 		    (object ClassAttribute "iScheduleId"

   747 			quid       	"3588F261007D"

   748 			type       	"TInt")))

   749 	    (object Class "RScheduler"

   750 		quid       	"3588FA6800AA"

   751 		documentation 	

   752 |

   753 |This is the client-side representation of a session with the scheduler; thus this is the API for the thing.

   754 |

   755 |N.B. There are in fact two 'ScheduleTask' functions, distinguished by their parameters. One schedules a task with an existing, persistent schedule, the other creates a new transient schedule and schedules the task with that.

   756 		

   757 		used_nodes 	(list uses_relationship_list

   758 		    (object Uses_Relationship

   759 			quid       	"3588FB460095"

   760 			supplier   	"TScheduleEntryInfo"

   761 			quidu      	"3588FA7702BE")

   762 		    (object Uses_Relationship

   763 			quid       	"3588FB490220"

   764 			supplier   	"TTaskInfo"

   765 			quidu      	"3587DA760264")

   766 		    (object Uses_Relationship

   767 			quid       	"358FA3AB02BE"

   768 			supplier   	"TScheduleState"

   769 			quidu      	"358FA35103AF")

   770 		    (object Uses_Relationship

   771 			quid       	"358FAB050351"

   772 			supplier   	"TSchedulerItemRef"

   773 			quidu      	"358FAACE01FD"))

   774 		operations 	(list Operations

   775 		    (object Operation "Register"

   776 			quid       	"3588FCFB0011"

   777 			parameters 	(list Parameters

   778 			    (object Parameter "argname"

   779 				type       	"argtype"

   780 				initv      	"default"))

   781 			result     	"return"

   782 			concurrency 	"Sequential"

   783 			opExportControl 	"Public"

   784 			uid        	0)

   785 		    (object Operation "CreatePersistentSchedule"

   786 			quid       	"3588FCFC01A3"

   787 			parameters 	(list Parameters

   788 			    (object Parameter "argname"

   789 				type       	"argtype"

   790 				initv      	"default"))

   791 			result     	"return"

   792 			concurrency 	"Sequential"

   793 			opExportControl 	"Public"

   794 			uid        	0)

   795 		    (object Operation "DeleteSchedule"

   796 			quid       	"3588FCFD033F"

   797 			parameters 	(list Parameters

   798 			    (object Parameter "argname"

   799 				type       	"argtype"

   800 				initv      	"default"))

   801 			result     	"return"

   802 			concurrency 	"Sequential"

   803 			opExportControl 	"Public"

   804 			uid        	0)

   805 		    (object Operation "DisableSchedule"

   806 			quid       	"3588FCFF00B7"

   807 			parameters 	(list Parameters

   808 			    (object Parameter "argname"

   809 				type       	"argtype"

   810 				initv      	"default"))

   811 			result     	"return"

   812 			concurrency 	"Sequential"

   813 			opExportControl 	"Public"

   814 			uid        	0)

   815 		    (object Operation "EnableSchedule"

   816 			quid       	"3588FD000249"

   817 			parameters 	(list Parameters

   818 			    (object Parameter "argname"

   819 				type       	"argtype"

   820 				initv      	"default"))

   821 			result     	"return"

   822 			concurrency 	"Sequential"

   823 			opExportControl 	"Public"

   824 			uid        	0)

   825 		    (object Operation "EditSchedule"

   826 			quid       	"3588FD0103E5"

   827 			parameters 	(list Parameters

   828 			    (object Parameter "argname"

   829 				type       	"argtype"

   830 				initv      	"default"))

   831 			result     	"return"

   832 			concurrency 	"Sequential"

   833 			opExportControl 	"Public"

   834 			uid        	0)

   835 		    (object Operation "ScheduleTask"

   836 			quid       	"3588FD03028A"

   837 			parameters 	(list Parameters

   838 			    (object Parameter "argname"

   839 				type       	"argtype"

   840 				initv      	"default"))

   841 			result     	"return"

   842 			concurrency 	"Sequential"

   843 			opExportControl 	"Public"

   844 			uid        	0)

   845 		    (object Operation "DeleteTask"

   846 			quid       	"3588FD050084"

   847 			parameters 	(list Parameters

   848 			    (object Parameter "argname"

   849 				type       	"argtype"

   850 				initv      	"default"))

   851 			result     	"return"

   852 			concurrency 	"Sequential"

   853 			opExportControl 	"Public"

   854 			uid        	0)

   855 		    (object Operation "GetScheduleRefsL"

   856 			quid       	"3588FD070087"

   857 			parameters 	(list Parameters

   858 			    (object Parameter "argname"

   859 				type       	"argtype"

   860 				initv      	"default"))

   861 			result     	"return"

   862 			concurrency 	"Sequential"

   863 			opExportControl 	"Public"

   864 			uid        	0)

   865 		    (object Operation "GetScheduleL"

   866 			quid       	"3588FD08033B"

   867 			parameters 	(list Parameters

   868 			    (object Parameter "argname"

   869 				type       	"argtype"

   870 				initv      	"default"))

   871 			result     	"return"

   872 			concurrency 	"Sequential"

   873 			opExportControl 	"Public"

   874 			uid        	0)

   875 		    (object Operation "GetTaskRefsL"

   876 			quid       	"3588FD0A0212"

   877 			parameters 	(list Parameters

   878 			    (object Parameter "argname"

   879 				type       	"argtype"

   880 				initv      	"default"))

   881 			result     	"return"

   882 			concurrency 	"Sequential"

   883 			opExportControl 	"Public"

   884 			uid        	0)

   885 		    (object Operation "GetTaskInfoL"

   886 			quid       	"3588FDB502F4"

   887 			parameters 	(list Parameters

   888 			    (object Parameter "argname"

   889 				type       	"argtype"

   890 				initv      	"default"))

   891 			result     	"return"

   892 			concurrency 	"Sequential"

   893 			opExportControl 	"Public"

   894 			uid        	0)

   895 		    (object Operation "GetTaskDataSize"

   896 			quid       	"3588FDB7018E"

   897 			parameters 	(list Parameters

   898 			    (object Parameter "argname"

   899 				type       	"argtype"

   900 				initv      	"default"))

   901 			result     	"return"

   902 			concurrency 	"Sequential"

   903 			opExportControl 	"Public"

   904 			uid        	0)))

   905 	    (object Class "TScheduleEntryInfo"

   906 		quid       	"3588FA7702BE"

   907 		documentation 	

   908 |

   909 |

   910 |This is passed to the scheduler when you create a schedule, and passed back again when you retireve it. 

   911 |You need one of these for each schedule entry in your schedule.

   912 		

   913 		class_attributes 	(list class_attribute_list

   914 		    (object ClassAttribute "iIntervalType"

   915 			quid       	"3588FB8800EA"

   916 			type       	"TIntervalType")

   917 		    (object ClassAttribute "iInterval"

   918 			quid       	"3588FB8A0057"

   919 			type       	"TInterval")

   920 		    (object ClassAttribute "iStartTime"

   921 			quid       	"3588FB8C00BE"

   922 			type       	"TTime")

   923 		    (object ClassAttribute "iValidityPeriod"

   924 			quid       	"3588FB8E0002"

   925 			type       	"TTimeIntervalMinutes")))

   926 	    (object Class "TScheduleState"

   927 		quid       	"358FA35103AF"

   928 		class_attributes 	(list class_attribute_list

   929 		    (object ClassAttribute "iName"

   930 			quid       	"358FA361024A"

   931 			type       	"TName")

   932 		    (object ClassAttribute "iDueTime"

   933 			quid       	"358FA3710225"

   934 			type       	"TTime")

   935 		    (object ClassAttribute "iPersists"

   936 			quid       	"358FA38201B1"

   937 			type       	"TBool")

   938 		    (object ClassAttribute "iEnabled"

   939 			quid       	"358FA3900251"

   940 			type       	"TBool")))

   941 	    (object Class "TSchedulerItemRef"

   942 		quid       	"358FAACE01FD"

   943 		class_attributes 	(list class_attribute_list

   944 		    (object ClassAttribute "iName"

   945 			quid       	"358FAADF00CB"

   946 			type       	"TName")

   947 		    (object ClassAttribute "iHandle"

   948 			quid       	"358FAAEE01D1"

   949 			type       	"TInt")))

   950 	    (object Association "iClient"

   951 		quid       	"34FAF6FD00A3"

   952 		roles      	(list role_list

   953 		    (object Role "$UNNAMED$2"

   954 			quid       	"34FAF6FD02C0"

   955 			supplier   	"CClientProxy"

   956 			quidu      	"34D1CB1B03A7")

   957 		    (object Role "$UNNAMED$3"

   958 			quid       	"34FAF6FD02DE"

   959 			supplier   	"TScheduledTask"

   960 			quidu      	"34D1CCE902E3")))

   961 	    (object Association "$UNNAMED$4"

   962 		quid       	"34FD88580389"

   963 		roles      	(list role_list

   964 		    (object Role "$UNNAMED$5"

   965 			quid       	"34FD885903BD"

   966 			supplier   	"CTaskScheduler"

   967 			quidu      	"34D1C70C0186"

   968 			is_navigable 	TRUE)

   969 		    (object Role "$UNNAMED$6"

   970 			quid       	"34FD885A007F"

   971 			supplier   	"CServiceTimer"

   972 			quidu      	"34D1CB1C0005"

   973 			is_navigable 	TRUE)))

   974 	    (object Association "iPendingSchedules"

   975 		quid       	"34FD89A201FD"

   976 		roles      	(list role_list

   977 		    (object Role "$UNNAMED$7"

   978 			quid       	"34FD89A203CA"

   979 			supplier   	"CSchedule"

   980 			quidu      	"34D1CB1C0073")

   981 		    (object Role "$UNNAMED$8"

   982 			quid       	"34FD89A3000A"

   983 			supplier   	"CTaskScheduler"

   984 			quidu      	"34D1C70C0186")))

   985 	    (object Association "iClient"

   986 		quid       	"3587D95D009D"

   987 		roles      	(list role_list

   988 		    (object Role "$UNNAMED$9"

   989 			quid       	"3587D95D02D8"

   990 			supplier   	"CClientProxy"

   991 			quidu      	"34D1CB1B03A7"

   992 			client_cardinality 	(value cardinality "1..1")

   993 			is_navigable 	TRUE)

   994 		    (object Role "$UNNAMED$10"

   995 			quid       	"3587D95D0314"

   996 			supplier   	"CSchSession"

   997 			quidu      	"34D1C70C014A"

   998 			client_cardinality 	(value cardinality "1..1"))))

   999 	    (object Association "iTaskScheduler"

  1000 		quid       	"3587D96F036A"

  1001 		roles      	(list role_list

  1002 		    (object Role "$UNNAMED$11"

  1003 			quid       	"3587D97102CC"

  1004 			supplier   	"CTaskScheduler"

  1005 			quidu      	"34D1C70C0186"

  1006 			client_cardinality 	(value cardinality "1..1")

  1007 			is_navigable 	TRUE)

  1008 		    (object Role "$UNNAMED$12"

  1009 			quid       	"3587D9710313"

  1010 			supplier   	"CSchSession"

  1011 			quidu      	"34D1C70C014A"

  1012 			client_cardinality 	(value cardinality "1..1"))))

  1013 	    (object Association "iClient"

  1014 		quid       	"3587DB09037D"

  1015 		roles      	(list role_list

  1016 		    (object Role "$UNNAMED$13"

  1017 			quid       	"3587DB0A0216"

  1018 			supplier   	"CClientProxy"

  1019 			quidu      	"34D1CB1B03A7"

  1020 			is_navigable 	TRUE)

  1021 		    (object Role "$UNNAMED$14"

  1022 			quid       	"3587DB0A0248"

  1023 			supplier   	"TScheduledTask"

  1024 			quidu      	"34D1CCE902E3")))

  1025 	    (object Association "iTask"

  1026 		quid       	"3587DB0F00BF"

  1027 		roles      	(list role_list

  1028 		    (object Role "$UNNAMED$15"

  1029 			quid       	"3587DB100337"

  1030 			supplier   	"CScheduledTask"

  1031 			quidu      	"3587D90700A3"

  1032 			client_cardinality 	(value cardinality "1..1")

  1033 			is_navigable 	TRUE)

  1034 		    (object Role "$UNNAMED$16"

  1035 			quid       	"3587DB100338"

  1036 			supplier   	"TScheduledTask"

  1037 			quidu      	"34D1CCE902E3"

  1038 			client_cardinality 	(value cardinality "1..1"))))

  1039 	    (object Association "iTasks"

  1040 		quid       	"3587DB2A00FA"

  1041 		roles      	(list role_list

  1042 		    (object Role "$UNNAMED$17"

  1043 			quid       	"3587DB2A02A9"

  1044 			supplier   	"CSchedule"

  1045 			quidu      	"34D1CB1C0073"

  1046 			client_cardinality 	(value cardinality "1..1")

  1047 			is_aggregate 	TRUE)

  1048 		    (object Role "$UNNAMED$18"

  1049 			quid       	"3587DB2A02DB"

  1050 			supplier   	"TScheduledTask"

  1051 			quidu      	"34D1CCE902E3"

  1052 			client_cardinality 	(value cardinality "0..n")

  1053 			is_navigable 	TRUE)))

  1054 	    (object Association "iBackup"

  1055 		quid       	"3587DCB40377"

  1056 		roles      	(list role_list

  1057 		    (object Role "$UNNAMED$19"

  1058 			quid       	"3587DCB60149"

  1059 			supplier   	"CTaskScheduler"

  1060 			quidu      	"34D1C70C0186"

  1061 			client_cardinality 	(value cardinality "1..1")

  1062 			is_aggregate 	TRUE)

  1063 		    (object Role "$UNNAMED$20"

  1064 			quid       	"3587DCB6019A"

  1065 			supplier   	"TScheduleBackup"

  1066 			quidu      	"3587DC9303DE"

  1067 			client_cardinality 	(value cardinality "1..1")

  1068 			is_navigable 	TRUE)))

  1069 	    (object Association "iClients"

  1070 		quid       	"3587DD3F0377"

  1071 		roles      	(list role_list

  1072 		    (object Role "$UNNAMED$21"

  1073 			quid       	"3587DD4003B5"

  1074 			supplier   	"CTaskScheduler"

  1075 			quidu      	"34D1C70C0186"

  1076 			client_cardinality 	(value cardinality "1..1")

  1077 			is_aggregate 	TRUE)

  1078 		    (object Role "$UNNAMED$22"

  1079 			quid       	"3587DD41001D"

  1080 			supplier   	"CClientProxy"

  1081 			quidu      	"34D1CB1B03A7"

  1082 			client_cardinality 	(value cardinality "0..n")

  1083 			is_navigable 	TRUE)))

  1084 	    (object Association "iPending"

  1085 		quid       	"3587E24B0126"

  1086 		roles      	(list role_list

  1087 		    (object Role "$UNNAMED$23"

  1088 			quid       	"3587E24C038B"

  1089 			supplier   	"CSchedule"

  1090 			quidu      	"34D1CB1C0073"

  1091 			client_cardinality 	(value cardinality "0..n")

  1092 			is_navigable 	TRUE)

  1093 		    (object Role "$UNNAMED$24"

  1094 			quid       	"3587E24C03C7"

  1095 			supplier   	"CTaskScheduler"

  1096 			quidu      	"34D1C70C0186"

  1097 			client_cardinality 	(value cardinality "1..1"))))

  1098 	    (object Association "iSchedules"

  1099 		quid       	"3587E2510297"

  1100 		roles      	(list role_list

  1101 		    (object Role "$UNNAMED$25"

  1102 			quid       	"3587E2520357"

  1103 			supplier   	"CTaskScheduler"

  1104 			quidu      	"34D1C70C0186"

  1105 			client_cardinality 	(value cardinality "1..1")

  1106 			is_aggregate 	TRUE)

  1107 		    (object Role "$UNNAMED$26"

  1108 			quid       	"3587E25203B1"

  1109 			supplier   	"CSchedule"

  1110 			quidu      	"34D1CB1C0073"

  1111 			client_cardinality 	(value cardinality "0..n")

  1112 			is_navigable 	TRUE)))

  1113 	    (object Association "iTaskScheduler"

  1114 		quid       	"3587E34000D8"

  1115 		roles      	(list role_list

  1116 		    (object Role "$UNNAMED$27"

  1117 			quid       	"3587E341030B"

  1118 			supplier   	"CTaskScheduler"

  1119 			quidu      	"34D1C70C0186"

  1120 			client_cardinality 	(value cardinality "1..1")

  1121 			is_navigable 	TRUE)

  1122 		    (object Role "$UNNAMED$28"

  1123 			quid       	"3587E341036F"

  1124 			supplier   	"CScheduleTimer"

  1125 			quidu      	"3587E1E90360"

  1126 			client_cardinality 	(value cardinality "1..1"))))

  1127 	    (object Association "iTimer"

  1128 		quid       	"3587E356021A"

  1129 		roles      	(list role_list

  1130 		    (object Role "$UNNAMED$29"

  1131 			quid       	"3587E3570104"

  1132 			supplier   	"CTaskScheduler"

  1133 			quidu      	"34D1C70C0186"

  1134 			client_cardinality 	(value cardinality "1..1")