Initial upload of draft interface.

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@30406 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5/interfaces/divergence_controller.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# garantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+
+from zope.interface import Interface
+
+class IDivergenceController(Interface):
+  """Divergence Controller interface specification
+
+  IDivergenceController provides methods to create new 
+  solver processes based on the current divergence of
+  deliveries, movements, simumlation movements.
+
+  IDivergenceController must be provided by 
+  movements, deliveries and by the SolverTool.
+  Actual implementation should be handled by SolverTool.
+
+  Whenever movement is not provided, IDivergenceController 
+  instances should use the most appropriate document 
+  such as self for a delivery movement. 
+
+  Whenever divergence_tester is not provided, all
+  applicable divergences are considered.
+  """
+
+  def isDivergent(self, movement=None):
+    """
+    Returns True if any of the movements provided 
+    in delivery_or_movement is divergent.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+    """
+
+  def newSolverProcess(self, movement=None):
+    """
+    Builds a new solver process from the divergence
+    analaysis of delivery_or_movement. All movements
+    which are not divergence are placed in a Solver
+    Decision with no Divergence Tester specified.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+    """
+
+  def getSolverProcessValueList(self, movement=None, validation_state=None):
+    """
+    Returns the list of solver processes which are
+    are in a given state and which apply to delivery_or_movement.
+    This method is useful to find applicable solver processes
+    for a delivery.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+
+    validation_state -- a state of a list of states
+                        to filter the result
+    """
+
+  def getSolverDecisionValueList(self, movement=None, validation_state=None):
+    """
+    Returns the list of solver decisions which apply
+    to a given movement.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+
+    validation_state -- a state of a list of states
+                        to filter the result
+    """
+
+  def getSolvedPropertyApplicationValueList(self, movement=None, divergence_tester=None):
+    """
+    Returns the list of documents at which a given divergence resolution
+    can be resolved at. For example, in most cases, date divergences can
+    only be resolved at delivery level whereas quantities are usually
+    resolved at cell level.
+
+    The result of this method is a list of ERP5 documents.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+    """