Changes between Version 9 and Version 10 of BossaReference

Timestamp:

Jul 18, 2008, 9:45:39 PM (17 years ago)

Author:

davea

Comment:

--

BossaReference

@@ -9 +9 @@
 
 Each of these is represented by a table in a MySQL database.
+
+Each application has an associated "time estimate" - shown to user - and
+"time limit"; if an instance is not completed within the time limit,
+is is considered "timed out".
 
 Jobs may be marked as '''calibration jobs'''.
@@ -77 +81 @@
 Initial priorities are one.
 Returns true on success.
+
+== Application functions ==
+
+Each application must define a set of functions, listed below.
+These are stored in a file '''project/html/inc/APPNAME.inc''',
+where APPNAME is the application's short name.
+
+{{{
+bool job_show(object $job, object $instance, object $user)
+}}}
+
+Display the given job instance to the given user.
+Return true on success.
+
+A job may consist of a single web page or a sequence of web pages.
+In either case the "done" action on the final page must go to the URL
+'''bossa_job_finished.php''', passing it a GET argument '''bji''' consisting
+of the ID of the job instance.
+
+{{{
+job_issued(object $job, object $inst, object $user)
+}}}
+Called when the given instance has timed out.
+
+{{{
+job_finished(object $job, object $inst, object $user)
+}}}
+
+Called when the given instance has finished.
+
+{{{
+job_timed_out(object $job, object $inst, object $user)
+}}}
+
+Called when the given instance has timed out.
+
+{{{
+string job_summary(object $job)
+}}}
+
+Return a short string describing the job,
+for use in administrative pages.
+For example, this might return an image name hyperlinked to the image.
+
+{{{
+string instance_summary(object $info)
+}}}
+
+Return a string summarizing the app data for an instance.
+
+{{{
+string user_summary(object $user)
+}}}
+
+Return a string summarizing the app data for a user.