[Zope3-checkins] CVS: Zope3/lib/python/Zope/App/Workflow - IWorkflowHistoryStorage.py:1.1.2.2 IWorkflowNode.py:1.1.2.2 IWorkflowProcessDefinition.py:1.1.2.2 IWorkflowProcessInstance.py:1.2.24.2 IWorkflowWorkitem.py:1.2.24.2 IWorkflowWorkitemStorage.py:1.1.2.2 IWorkflowWorklistHandler.py:1.1.2.2

[Ulrich Eck]

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

Modified Files:
      Tag: sprintathon-wf-branch
	IWorkflowHistoryStorage.py IWorkflowNode.py 
	IWorkflowProcessDefinition.py IWorkflowProcessInstance.py 
	IWorkflowWorkitem.py IWorkflowWorkitemStorage.py 
	IWorkflowWorklistHandler.py 
Log Message:
jack: added some comments for interface discussion


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowHistoryStorage.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowHistoryStorage.py:1.1.2.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowHistoryStorage.py	Wed Dec  4 04:05:11 2002
@@ -24,6 +24,8 @@
     Base interface for History Storage.
     """
 
+    # XXX Relate History to ProcessInstance not WorkItem ???
+
     def loadHistoryRecord(wi_id):
         """Load a History Record
         """


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowNode.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowNode.py:1.1.2.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowNode.py	Wed Dec  4 04:05:11 2002
@@ -19,6 +19,7 @@
 
 from Interface import Interface
 
+# XXX Implementation specific (drop for general if)
 class IWorkflowNode(Interface):
     """Interface for Workflow Node.
 


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowProcessDefinition.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowProcessDefinition.py:1.1.2.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowProcessDefinition.py	Wed Dec  4 04:05:11 2002
@@ -24,11 +24,20 @@
 
     """
 
-    workflow_implementation_type = Attribute("""The name of the workflow type""")
+    name = Attribute("""The name of the ProcessDefinition""")
+
 
+    # XXX drop
+    workflow_implementation_type = Attribute("""The name of the workflow type""")
     workflow_relevant_data_definition = Attribute("""The definition of workflow \
     relevant data of type [{name:'', data_tpye:''}]""")
     # relevant data declaration may be sequence of objects instead of a dictionary
+
+
+
+
+    # XXX Implementation specific below ????
+    # XXX use explicit Names (State/Activity) instead of generalized ones
 
     nodes = Attribute("""The sequence of nodes""")
     transitions = Attribute("""The sequence of transitions""")


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowProcessInstance.py 1.2.24.1 => 1.2.24.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowProcessInstance.py:1.2.24.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowProcessInstance.py	Wed Dec  4 04:05:11 2002
@@ -25,17 +25,19 @@
         Represents the instance of a Process defined by a WorkflowProcessDefinition."""
 
     status = Attribute("""The state in which the workitem is""")
+    
+    # XXX no private attribute are exposed in interfaces
     workitem_list = Attribute("""The list of WorlflowWorkitem for the current WorkflowProcessInstance""")
-    process_definition = Attributes("""The WorkflowProcessDefinition used to create this instance""")
+    process_definition = Attribute("""The WorkflowProcessDefinition used to create this instance""")
     
-    def setStatus():
+    def setStatus():  # XXX Property ??
         """Set the process instance status
         """
         
     def getProcessDefinition():
         """Gets the process definition for this process instance."""
 
-    def getStatus():
+    def getStatus():  # XXX Property
         """
            Report the status
         """


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowWorkitem.py 1.2.24.1 => 1.2.24.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowWorkitem.py:1.2.24.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowWorkitem.py	Wed Dec  4 04:05:11 2002
@@ -24,6 +24,7 @@
     Base interface for workitems.
     """
 
+    # XXX Stay with Attributes only ???
     assignee = Attribute("""The user in charge of accomplish the task""")
     status = Attibute("""The state in which the workitem is""")
 


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowWorkitemStorage.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowWorkitemStorage.py:1.1.2.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowWorkitemStorage.py	Wed Dec  4 04:05:11 2002
@@ -24,10 +24,13 @@
     Base interface for Workitem Storage.
     """
 
+    # XXX shorter names ?? e.g. __getitem__ or just get/set ??
+
     def loadWorkitem(wi_id):
         """Load a Workitem
         """
 
+    # XXX need object to store
     def storeWorkitem(wi_id):
         """store a Workitem
         """


=== Zope3/lib/python/Zope/App/Workflow/IWorkflowWorklistHandler.py 1.1.2.1 => 1.1.2.2 ===
--- Zope3/lib/python/Zope/App/Workflow/IWorkflowWorklistHandler.py:1.1.2.1	Tue Dec  3 10:35:47 2002
+++ Zope3/lib/python/Zope/App/Workflow/IWorkflowWorklistHandler.py	Wed Dec  4 04:05:11 2002
@@ -24,5 +24,7 @@
     Base interface for Worklist Handler.
     """
 
+    # XXX getWorkitems ?? (names might not be unique!!)
+
     def getWorkitemNames(filter):
         """Return a sequence of workitem"""