Changes between Version 20 and Version 21 of WorkFlow

Timestamp:

Jan 30, 2006, 3:50:36 PM (18 years ago)

Author:

Alec Thomas

Comment:

Added ITicketManipulator

WorkFlow

@@ -63 +63 @@
 
 == Plugabble Workflow ==
-For more complex ticket workflow requirements an extension point is available,
+For more complex ticket workflow requirements two extension points are available,
 allowing full control of the ticket workflow process.
 
 {{{
 #!python
+class ITicketManipulator(Interface):
+    """
+    ITicketManipulator implementations are used to perform filtering of
+    visible fields and validation.
+    """
+
+    # Control ticket fields
+    def filter_ticket_fields(req, ticket, fields):
+        """ Given a list of ticket.Field objects and a ticket, return the
+            filtered list of fields. Called just prior to ticket display. """
+
+    def validate_ticket(req, ticket):
+        """ Validate a ticket. Called just before the ticket is updated with
+            user supplied values from req.args. """
+
 class ITicketWorkflow(Interface):
-    """ This interface controls what actions can be performed on a ticket and
-        also a list of the available ticket fields. """
+    """ This interface controls what actions can be performed on a ticket. """
 
     # Control ticket actions
@@ -77 +91 @@
             ticket and the request object provided. """
 
-    def get_ticket_action(req, ticket, action):
+    def get_ticket_action_controls(req, ticket, action):
         """ Return a trac.ticket.field.Field object for ticket action. """
 
     def apply_ticket_action(req, ticket, action):
         """ Perform action on ticket. """
-
-    # Control ticket fields
-    def filter_ticket_fields(req, ticket, fields):
-        """ Given a list of ticket.Field objects and a ticket, return the
-            filtered list of fields. This method must enforce permission
-            control on all fields. """
-
-    def update_ticket_fields(req, ticket):
-        """ Apply changes in req to ticket. By default this should simply be
-            `ticket.populate(req.args)`. """
 }}}