(object Petal

    version    	40)

(object Design "Logical View"

    is_unit    	TRUE

    is_loaded  	TRUE

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

    quid       	"3607CDBF00DB"

    defaults   	(object defaults

	rightMargin 	0.250000

	leftMargin 	0.250000

	topMargin  	0.250000

	bottomMargin 	0.500000

	pageOverlap 	0.250000

	clipIconLabels 	TRUE

	autoResize 	FALSE

	snapToGrid 	TRUE

	gridX      	16

	gridY      	16

	defaultFont 	(object Font

	    size       	10

	    face       	"Arial"

	    bold       	FALSE

	    italics    	FALSE

	    underline  	FALSE

	    strike     	FALSE

	    color      	0

	    default_color 	TRUE)

	showMessageNum 	3

	showClassOfObject 	TRUE

	notation   	"Unified")

    root_usecase_package 	(object Class_Category "Use Case View"

	quid       	"34B4B32D038B"

	exportControl 	"Public"

	global     	TRUE

	logical_models 	(list unit_reference_list)

	logical_presentations 	(list unit_reference_list

	    (object UseCaseDiagram "Main"

		quid       	"358F97CC012F"

		title      	"Main"

		zoom       	100

		max_height 	28350

		max_width  	21600

		origin_x   	0

		origin_y   	0

		items      	(list diagram_item_list))))

    root_category 	(object Class_Category "Logical View"

	quid       	"34B4B32D038A"

	exportControl 	"Public"

	global     	TRUE

	subsystem  	"Component View"

	quidu      	"34B4B32D038C"

	logical_models 	(list unit_reference_list

	    (object Class "CServer"

		quid       	"34D1C70C010E"

		abstract   	TRUE

		operations 	(list Operations

		    (object Operation "RunL"

			quid       	"34D1C726002F"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "Start"

			quid       	"34D1C73102B6"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)))

	    (object Class "CSession"

		quid       	"34D1C70C0168"

		abstract   	TRUE)

	    (object Class "CSchSession"

		quid       	"34D1C70C014A"

		documentation 	

|

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

|Initialised on creation with the instance of CTaskScheduler. 

|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.

		superclasses 	(list inheritance_relationship_list

		    (object Inheritance_Relationship

			quid       	"34D1C70C014B"

			supplier   	"CSession"

			quidu      	"34D1C70C0168"))

		used_nodes 	(list uses_relationship_list

		    (object Uses_Relationship

			quid       	"352B456F0032"

			label      	"iSchedules"

			supplier   	"CSchedule"

			quidu      	"34D1CB1C0073"

			supplier_cardinality 	(value cardinality "0..n")

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

		operations 	(list Operations

		    (object Operation "ServiceL"

			quid       	"34D1C74003BB"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)))

	    (object Class "CSchServer"

		quid       	"34D1C70C0110"

		documentation 	

|

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

|Owns (indirectly) everything else.

		superclasses 	(list inheritance_relationship_list

		    (object Inheritance_Relationship

			quid       	"34D1C70C010F"

			supplier   	"CServer"

			quidu      	"34D1C70C010E")))

	    (object Class "CTaskScheduler"

		quid       	"34D1C70C0186"

		documentation 	

|- Owns all the other scheduler objects.

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

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

|- Provides an interface for scheduling tasks

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

|- Executes clients when appropriate

|- 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

|- Maintains schedule instances in TWO lists:

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

|       -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.

|

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

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

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

|

|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.

		fields     	(list has_relationship_list

		    (object Has_Relationship

			quid       	"34D1C70C0187"

			label      	"iTimer"

			supplier   	"CServiceTimer"

			quidu      	"34D1CB1C0005"

			supplier_cardinality 	(value cardinality "1..1")

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

		operations 	(list Operations

		    (object Operation "ScheduleTaskL"

			quid       	"34D1C70C018A"

			parameters 	(list Parameters

			    (object Parameter "aUser"

				type       	"TUid")

			    (object Parameter "aItem"

				type       	"TInt")

			    (object Parameter "aAction"

				type       	"TItemAction")

			    (object Parameter "aSchedule"

				type       	"TScheduleInfo"))

			result     	"void"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "DeleteTaskL"

			quid       	"34D1C70C018F"

			parameters 	(list Parameters

			    (object Parameter "aUser"

				type       	"TUid")

			    (object Parameter "aItem"

				type       	"TInt"))

			result     	"return"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "NewScheduleL"

			quid       	"34D1C70C0192"

			parameters 	(list Parameters

			    (object Parameter "aUser"

				type       	"TUid"))

			result     	"return"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "DeleteScheduleL"

			quid       	"34D1C70C0194"

			parameters 	(list Parameters

			    (object Parameter "aUser"

				type       	"TUid"))

			result     	"return"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "RegisterClientL"

			quid       	"34D1C70C0196"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "EditScheduleL"

			quid       	"34D1C70C0197"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "DueTaskNotify"

			quid       	"352B45320229"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "ExecuteClients"

			quid       	"352B453D0095"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0))

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iNotifier"

			quid       	"3587EEDB01FD"

			type       	"CEnvironmentChangeNotifier")

		    (object ClassAttribute "iBackup"

			quid       	"3587F07A0380"

			type       	"TScheduleBackup"))

		statediagram 	(object State_Diagram ""

		    quid       	"3587F1420279"

		    title      	""

		    zoom       	100

		    max_height 	28350

		    max_width  	21600

		    origin_x   	0

		    origin_y   	0

		    items      	(list diagram_item_list)))

	    (object Class "CClientProxy"

		quid       	"34D1CB1B03A7"

		documentation 	

|

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

|

|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.

|When it's told to execute, it:

| - saves all its due tasks to a file

| - 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

| - tells it to execute the tasks

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

|

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

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

|AND  - there are no pending tasks belonging to it  

		used_nodes 	(list uses_relationship_list

		    (object Uses_Relationship

			quid       	"34D1CB1B03A8"

			label      	"iSchedules"

			supplier   	"TScheduleEntry"

			quidu      	"34D1CB1C0091"

			supplier_cardinality 	(value cardinality "0..n")

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

		    (object Uses_Relationship

			quid       	"3587DC1100C0"

			supplier   	"CTaskExecutor"

			quidu      	"3587DB8B0352"))

		operations 	(list Operations

		    (object Operation "Execute()"

			quid       	"34FAE9140125"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0))

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iTaskExecutor"

			quid       	"34D1CB1B03B2"

			type       	"TFileName")

		    (object ClassAttribute "iClientPriority"

			quid       	"34FAE57802F3"

			type       	"TInt"

			exportControl 	"Public")

		    (object ClassAttribute "iUsers"

			quid       	"3588DFB30261"

			type       	"TInt")))

	    (object Class "CTimer"

		quid       	"34D1CB1C0023")

	    (object Class "CServiceTimer"

		quid       	"34D1CB1C0005"

		superclasses 	(list inheritance_relationship_list

		    (object Inheritance_Relationship

			quid       	"34D1CB1C0006"

			supplier   	"CTimer"

			quidu      	"34D1CB1C0023"))

		operations 	(list Operations

		    (object Operation "SetDueTime"

			quid       	"34D1CB1C0007"

			parameters 	(list Parameters

			    (object Parameter "aNewTime"

				type       	"TTime"))

			result     	"return"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "DueTime"

			quid       	"34D1CB1C000F"

			result     	"TTime"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0))

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iDueTime"

			quid       	"34D1CB1C0010"

			type       	"TTime")

		    (object ClassAttribute "iCallback"

			quid       	"34D1CB1C0011"

			type       	"TCallback")))

	    (object Class "CSchedule"

		quid       	"34D1CB1C0073"

		documentation 	

|

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

|

|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. 

|

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

|

|It has 2 flags of type TBool:

|    - 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.

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

|

		fields     	(list has_relationship_list

		    (object Has_Relationship

			quid       	"34D1CB1C007D"

			label      	"iEntries"

			supplier   	"TScheduleEntry"

			quidu      	"34D1CB1C0091"

			exportControl 	"Private"

			supplier_cardinality 	(value cardinality "1..1")

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

		    (object Has_Relationship

			quid       	"352B481E0207"

			label      	"iTasks"

			supplier   	"TScheduledTask"

			quidu      	"34D1CCE902E3"

			supplier_cardinality 	(value cardinality "0..n")

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

		operations 	(list Operations

		    (object Operation "AddEntry"

			quid       	"34D1CB7503BA"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "RemoveEntry"

			quid       	"34D1CB7B035F"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "AddTask"

			quid       	"34D991F00386"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "DueTime"

			quid       	"34D9922800FC"

			result     	"TTime"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "FirstScheduledTime"

			quid       	"34D9A92301AF"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "NextScheduledTime"

			quid       	"34D9A9360185"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "NotifyClients"

			quid       	"352B478A0055"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "NewL"

			quid       	"3588EC8003CC"

			parameters 	(list Parameters

			    (object Parameter "aStore"

				type       	"CFileStore")

			    (object Parameter "aId"

				type       	"TStreamId"))

			result     	"CSchedule"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "StoreL"

			quid       	"3588ECED0058"

			parameters 	(list Parameters

			    (object Parameter "aStore"

				type       	"CFileStore"))

			result     	"TStreamId"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "RestoreL"

			quid       	"3588ED2E014B"

			parameters 	(list Parameters

			    (object Parameter "aStore"

				type       	"CFileStore")

			    (object Parameter "aId"

				type       	"TStreamId"))

			result     	"void"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)

		    (object Operation "UpdateStoreL"

			quid       	"3588ED490371"

			parameters 	(list Parameters

			    (object Parameter "aStore"

				type       	"CPermanentFileStore")

			    (object Parameter "aId"

				type       	"TStreamId"))

			result     	"void"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0))

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iDueTime"

			quid       	"34D991DF01F1"

			type       	"TTime")

		    (object ClassAttribute "iPersists"

			quid       	"3587F3B8001C"

			type       	"TBool")

		    (object ClassAttribute "iEnabled"

			quid       	"3587F3BE0378"

			type       	"TBool"

			exportControl 	"Public")))

	    (object Class "TScheduleEntry"

		quid       	"34D1CB1C0091"

		documentation 	

|

|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.

|

|TScheduleEntry is abstract; it has 4 subclasses:

|

|TScheduleEntryHourly

|TScheduleEntryDaily

|TScheduleEntryMonthly

|TScheduleEntryYearly

|

|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.

|

|

		abstract   	TRUE

		operations 	(list Operations

		    (object Operation "NextScheduledTime"

			quid       	"34D1CB1C0092"

			result     	"TTime"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0)))

	    (object Class "TScheduledTask"

		quid       	"34D1CCE902E3"

		documentation 	

|

|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. 

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

		operations 	(list Operations

		    (object Operation "OnDue"

			quid       	"3588DF80004B"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0))

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iClient"

			quid       	"3587DADF025B"

			type       	"CClientProxy")

		    (object ClassAttribute "iTask"

			quid       	"3587DAE40398"

			type       	"CScheduledTask")))

	    (object Class "CScheduledTask"

		quid       	"3587D90700A3"

		documentation 	

|

|This is where the real task data is kept:

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

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

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

|

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

| 

|

|

		operations 	(list Operations

		    (object Operation "OnDue"

			quid       	"3588DF9B02C1"

			concurrency 	"Sequential"

			opExportControl 	"Public"

			uid        	0))

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iInfo"

			quid       	"3587DB3E01B7"

			type       	"TTaskInfo")

		    (object ClassAttribute "iData"

			quid       	"3587DB4803B0"

			type       	"HBufC")))

	    (object Class "TTaskInfo"

		quid       	"3587DA760264"

		documentation 	

|

|

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

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

		class_attributes 	(list class_attribute_list

		    (object ClassAttribute "iRepeat"

			quid       	"3588FADE0186"

			type       	"TInt")

		    (object ClassAttribute "iName"

			quid       	"3588FAE5024E"

			type       	"TName")

		    (object ClassAttribute "iTaskId"

			quid       	"3588FAE70356"

			type       	"TInt")

		    (object ClassAttribute "iPriority"

			quid       	"3588FAED0386"

			type       	"TInt")))

	    (object Class "CTaskExecutor"

		quid       	"3587DB8B0352"

		documentation 	

|

|This class encapsulates the actual task executing business.

|It's initialized with:

| - the name of the executing program

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

|

|When it's told to execute, it:

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

| - logs on to the process                            

| - runs the executing program in it

|This program

| - creates a new clean up stack

| - opens the file with the tasks in it

| - internalizes the tasks