Changes between Version 37 and Version 38 of S3/S3REST/s3_rest_controller

Timestamp:

10/24/10 06:36:56 (15 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/s3_rest_controller

@@ -82 +82 @@
 ==== Validation Callbacks ====
 
-After successful submission of a create/update form (=the input data have successfully passed the field validation), you can define extra form validation methods to be invoked by using:
+You can define extra form validation methods to be invoked after a create/update form has successfully passed the indivdual field validation, by using:
 
 {{{
@@ -104 +104 @@
 This allows you to define a common onvalidation callback for both ''create'' and ''update''.
 
-Onvalidation callbacks are meant to allow additional form data validation (beyond individual field validators). The callables receive the '''form''' as first and only parameter, while their return values will be ignored.
+Onvalidation callbacks are meant to allow additional form data validation (beyond individual field validators). The callback functions receive the '''form''' as first and only parameter, while their return values will be ignored.
 
 Any validation errors are to be reported directly into the form as:
@@ -122 +122 @@
 ==== On-accept Callbacks ====
 
+You can define methods to be invoked after a record has been created/updated, by using:
+
+{{{
+s3xrc.model.configure(table, create_onaccept=callback)
+}}}
+{{{
+s3xrc.model.configure(table, update_onaccept=callback)
+}}}
+
+where:
+
+  - '''table''' is the respective DB table
+  - '''callable''' is the callback setting, see [#Callbacks Callbacks]
+
+If either of {{{create_onaccept}}} or {{{update_onaccept}}} is not set, then the {{{onaccept}}} setting is tried:
+
+{{{
+s3xrc.model.configure(table, onaccept=callback)
+}}}
+
+This allows you to define a common onaccept callback for both ''create'' and ''update''.
+
+The {{{onaccept}}} callbacks are meant to perform extra post-processing of the newly created/updated record (e.g. to update dependent records). The callback functions receive the respective '''record''' as first and only parameter, while their return value will be ignored.
+
 ==== On-Delete Callback ====
+
+You can define methods to be invoked after a record has been deleted, by using:
+
+{{{
+s3xrc.model.configure(table, ondelete=callback)
+}}}
+
+where:
+
+  - '''table''' is the respective DB table
+  - '''callable''' is the callback setting, see [#Callbacks Callbacks]
+
+The {{{ondelete}}} callbacks are meant to perform extra post-processing of the deleted record (e.g. to update dependent records). The callback functions receive the respective '''record''' as first and only parameter, while their return value will be ignored.
+
+Note:
+  At the time when the callback is invoked, the record is already deleted from the database.
+
 === Pagination ===
 
@@ -134 +175 @@
 response.s3.no_sspag=True
 }}}
+
 == View Control ==