[Zope-Checkins] CVS: Zope3/lib/python/Zope/App/Workflow - IWorkflowEvents.py:1.1.2.6

Tres Seaver tseaver@zope.com
Tue, 5 Mar 2002 06:27:13 -0500


Update of /cvs-repository/Zope3/lib/python/Zope/App/Workflow
In directory cvs.zope.org:/tmp/cvs-serv4017

Modified Files:
      Tag: Zope-3x-branch
	IWorkflowEvents.py 
Log Message:
 - Refactor duplication (interfaces) into base classes.

=== Zope3/lib/python/Zope/App/Workflow/IWorkflowEvents.py 1.1.2.5 => 1.1.2.6 ===
     """
 
+class IWorkflowActionEvent( IWorkflowEvent ):
+    """
+        Common base for events related to workflow-aware components
+        (e.g.  WorkItems, for WfMC-style activity-based workflows,
+        or a new content object, for DCWorkflow-style document-based
+        workflows).
+    """
+    def getAction():
+        """
+            Return the workflow-aware component which the event is
+            "about".
+        """
 
-class IWorkflowActionCreatedEvent( IWorkflowEvent ):
+class IWorkflowActionCreatedEvent( IWorkflowActionEvent ):
     """
         Note the creation of a new workflow-aware component (a
         WorkItem, for WfMC-style activity-based workflows, or a
         new content object, for DCWorkflow-style document-based
         workflows.
     """
-    def getAction():
-        """
-            Return the created object.
-        """
 
-class IWorkflowActionAssignedEvent( IWorkflowEvent ):
+class IWorkflowActionAssignedEvent( IWorkflowActionEvent ):
     """
         Note the assignment of a workflow-aware action.
     """
-    def getAction():
-        """
-        """
 
-
-class IWorkflowActionBegunEvent( IWorkflowEvent ):
+class IWorkflowActionBegunEvent( IWorkflowActionEvent ):
     """
         Note the beginning of a workflow-aware action.
     """
-    def getAction():
-        """
-        """
 
 class IWorkflowActionCompletedEvent(IWorkflowEvent):
     """
-    Note the completion of a WorkItem or a transition.
+        Note the completion of a WorkItem or a transition.
     """
-    def getAction():
-        """
-        Return the action that was just completed.
-        """
 
-class IWorkflowActionSuspendedEvent( IWorkflowEvent ):
+class IWorkflowActionSuspendedEvent( IWorkflowActionEvent ):
     """
         Note the suspension of a workflow-aware action.
     """
-    def getAction():
-        """
-        """
 
-class IWorkflowActionTerminatedEvent( IWorkflowEvent ):
+class IWorkflowActionTerminatedEvent( IWorkflowActionEvent ):
     """
         Note the suspension of a workflow-aware action.
     """
-    def getAction():
-        """
-        """
 
 class IWorkflowActionExceptionEvent(IWorkflowEvent):
     """
-    Note that the execution of an action had an exceptional termination.
+        Note that the execution of an action had an exceptional termination.
     """
-    def getAction():
-        """
-        Return the action that had an exception.
-        """