lib/openwfe/participants/participant.rb in openwferu-0.9.14 vs lib/openwfe/participants/participant.rb in openwferu-0.9.15

@@ -46,16 +46,27 @@
 
     #
     # The 'participant' concept is displayed as a module, so that 
     # other pieces of code may easily 'mix it in'.
     #
+    # Participant extensions should at least provide a consume(workitem)
+    # method.
+    # As an option, it can provide a cancel(cancelitem) method.
+    #
+    # The engine will transmit instances of OpenWFE:WorkItem via the
+    # consume method.
+    #
+    # If there is a cancel method available and an OpenWFE::CancelItem instance
+    # is emitted (cancelling a process or part of it), it will be fed to
+    # the participant only via the cancel method.
+    #
+    # If there is no cancel method, the participant will not get notified
+    # of the cancellation.
+    #
     module Participant
 
         #
-        # A participant will be receiving workitems via this method.
-        # It may also receive cancelitems via this method.
-        # If the participant provides a cancel(cancelitem) method, cancel
-        # items will be fed to this cancel() and not to consume().
+        # A Participant will be receiving OpenWFE::WorkItem's via this method.
         #
         def consume (workitem)
 
             raise NotImplementedError.new(
                 "implementation for method consume() "+