Changeset 6420 for main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.py

Timestamp:

20 Jun 2011, 14:44:37 (13 years ago)

Author:

uli

Message:

Support comments when doing accesscode transitions. These comments will appear in the respective access codes history.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.py (modified) (3 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/accesscodes/accesscodes.py

@@ -411 +411 @@
     return code
 
-def fire_transition(access_code, arg, toward=False):
+def fire_transition(access_code, arg, toward=False, comment=None):
     """Fire workflow transition for access code.
 
@@ -424 +424 @@
     transition id as `arg`, otherwise you must give a transition
     target.
+
+    If `comment` is specified (default is ``None``) the given string
+    will be passed along as transition comment. It will appear in the
+    history of the changed access code. You can use this to place
+    remarks like for which object the access code was used or similar.
 
     :func:`fire_transition` might raise exceptions depending on the
@@ -458 +463 @@
     info = IWorkflowInfo(ac)
     if toward:
-        info.fireTransitionToward(arg)
+        info.fireTransitionToward(arg, comment=comment)
     else:
-        info.fireTransition(arg)
+        info.fireTransition(arg, comment=comment)
     return True
 
-def invalidate_accesscode(access_code):
+def invalidate_accesscode(access_code, comment=None):
     """Invalidate AccessCode denoted by string ``access_code``.
 
     Fires an appropriate transition to perform the task.
+
+    `comment` is a string that will appear in the access code
+    history.
 
     See :func:`fire_transition` for possible exceptions and their
     meanings.
     """
-    return fire_transition(access_code, 'use')
-
-def disable_accesscode(access_code):
+    return fire_transition(access_code, 'use', comment=comment)
+
+def disable_accesscode(access_code, comment=None):
     """Disable AccessCode denoted by string ``access_code``.
 
     Fires an appropriate transition to perform the task.
+
+    `comment` is a string that will appear in the access code
+    history.
 
     See :func:`fire_transition` for possible exceptions and their
     meanings.
     """
-    return fire_transition(access_code, DISABLED, toward=True)
-
-def reenable_accesscode(access_code):
+    return fire_transition(
+        access_code, DISABLED, toward=True, comment=comment)
+
+def reenable_accesscode(access_code, comment=None):
     """Reenable AccessCode denoted by string ``access_code``.
 
     Fires an appropriate transition to perform the task.
+
+    `comment` is a string that will appear in the access code
+    history.
 
     See :func:`fire_transition` for possible exceptions and their
     meanings.
     """
-    return fire_transition(access_code, 'reenable')
+    return fire_transition(access_code, 'reenable', comment=comment)