[Erp5-report] r30633 - /erp5/trunk/products/ERP5/interfaces/business_completable.py

[nobody at svn.erp5.org]

Author: jp
Date: Sun Nov 15 18:40:10 2009
New Revision: 30633

URL: http://svn.erp5.org?rev=30633&view=rev
Log:
Improved doc strings

Modified:
    erp5/trunk/products/ERP5/interfaces/business_completable.py

Modified: erp5/trunk/products/ERP5/interfaces/business_completable.py
URL: http://svn.erp5.org/erp5/trunk/products/ERP5/interfaces/business_completable.py?rev=30633&r1=30632&r2=30633&view=diff
==============================================================================
--- erp5/trunk/products/ERP5/interfaces/business_completable.py [utf8] (original)
+++ erp5/trunk/products/ERP5/interfaces/business_completable.py [utf8] Sun Nov 15 18:40:10 2009
@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 ##############################################################################
 #
 # Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
@@ -34,11 +35,16 @@
 class IBusinessCompletable(Interface):
   """Business Completable interface specification
 
-  Business states and path can be completed or partially completed.
+  This interface is implemented by Business Path and Business
+  States as part of Business Process Management. It can be
+  used to check whether a path or a state is completed, or
+  partially completed.
+
+  TODO: make sure interface can support simulation movements
   """
   def isCompleted(explanation):
     """True if all related simulation movements for this explanation
-    document are delivered and in simulation state which is considered
+    document are delivered and in a simulation state which is considered
     as finished.
 
     Completed means that it is possible to move to next step of Business Process
@@ -55,6 +61,9 @@
     are frozen.
 
     Frozen means that simulation movement cannot be modified.
+
+    NOTE: simulation movements can be frozen (ex. in stopped state) but
+    not yet completed (ex. in delivered state).
     """
 
   def getExpectedCompletionDate(task):
@@ -75,10 +84,9 @@
     """
 
   def getRemainingTradePhaseList(explanation, trade_phase_list=None):
+    """Returns the list of remaining trade phases which to be done on the
+    explanation.
+
+    trade_phase_list -- if provided, the result is filtered by it after
+                        being collected
     """
-      Returns the list of remaining trade phases which to be done on the
-      explanation.
-
-      trade_phase_list -- if provided, the result is filtered by it after
-                          being collected
-    """