Changes between Version 22 and Version 23 of RESTController

Timestamp:

11/20/09 01:39:05 (16 years ago)

Author:

Dominic König

Comment:

--

RESTController

@@ -171 +171 @@
 {{{
 # Plug into REST controller
-jrlayer.set_method(module, 'person', None, None, 'search_simple', shn_pr_person_search_simple )
+s3xrc.set_method(module, 'person', method='search_simple', action=shn_pr_person_search_simple )
 }}}
 
 Arguments of jrlayer.set_method:
 
-  * '''module''' = name of the module of the primary resource
-  * '''resource''' = name of the primary resource
-  * '''jmodule''' = name of the module of the joined resource (if any, maybe None)
-  * '''jresource''' = name of the joined resource (if any, maybe None)
-  * '''method''' = name of the method
-  * '''action''' = the function or lambda to invoke for that method (to remove a plug-in action, just pass None here)
+  * '''module''' = prefix of the module of the primary resource
+  * '''resource''' = name of the primary resource (without module prefix)
+  * '''component=None''' = tablename of the component (if this method applies to a component)
+  * '''method=None''' = name of the method
+  * '''action=None''' = the function or lambda to invoke for that method (to remove a plug-in action, just pass None here)
 
-The action method in turn has to take plenty of arguments:
+The action function has to take the following arguments:
 
-  * '''module'''
-  * '''resource'''
-  * '''record_id'''
-  * '''method'''
-  * '''jmodule=None'''
-  * '''jresource=None'''
-  * '''jrecord_id=None'''
-  * '''joinby=None'''
-  * '''multiple=True'''
-  * '''representation="html"'''
-  * '''onvalidation=None'''
-  * '''onaccept=None'''
+  * '''jr''' = an object of the type XRequest containing all data about the request
+  * '''onvalidation=None''' = function to called at create/update directly before writing to the database
+  * '''onaccept=None''' = function to be called at create/update directly after writing to the database
+
+The onvalidation/onaccept callback functions take a dictionary as argument that contains a {{{Storage()}}} object {{{vars}}} with fieldname=value pairs. They must not be invoked when operating on component records, instead use {{{s3xml.model.get_attr(component_tablename, "onvalidation")}}} to retrieve the respective callbacks for the component.