odoo
/
odoo
2
0
Fork 0
Code Pull Requests Releases Activity

[ADD] Added documentation for merge proposal, related to the need_action mixin class. 

bzr revid: tde@openerp.com-20120313122939-239ae3ftask1rrmb
This commit is contained in:
Thibault Delavallée 2012-03-13 13:29:39 +01:00
parent 94051b9812
commit 059cc5bef3
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/need_action_specs.rst Normal file
View File

@ -0,0 +1,8 @@
Need action mixin class
=======================
This revision adds a mixin class for object implementing the need action mechanism. Need action mechanism can be used by objects that have to be able to signal that an action is required on a particular record. If in the business logic an action must be performed by somebody, for instance validation by a manager, this mechanism allows to set a field with the user_id of the user requested to perform the action.
Technically, this class adds a need_action_user_id field; when set to false, no action is required; when an user_id is set, this user has an action to perform. This field is a function field. Setting an user_id is done through redefining the get_needaction_user_id method. Therefore by redefining only one method, you can specify the cases in which an action will be required on a particular record.
This mechanism is used for instance to display the number of pending actions in menus, such as Leads (12).

8
doc/index.rst.inc
View File

@ -6,3 +6,11 @@ OpenERP Server
:maxdepth: 1
test-framework
New feature merges
++++++++++++++++++
.. toctree::
:maxdepth: 1
api/need_action_specs