This business template contains python files that overrides existing files....

This business template contains python files that overrides existing files. Once TemplateTool supports installing documents whose class file exists in the same business template, all contents here should be merged into erp5_simulation business template.


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

bt5/erp5_simulation_core/DocumentTemplateItem/InvoicingRule.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SARL and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+"""
+XXX This file is experimental for new simulation implementation, and
+will replace InvoicingRule.
+"""
+
+import zope.interface
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet, interfaces
+from Products.ERP5.Document.Predicate import Predicate
+from Products.ERP5.mixin.rule import RuleMixin
+from Products.ERP5.mixin.movement_collection_updater import \
+     MovementCollectionUpdaterMixin
+from Products.ERP5.MovementCollectionDiff import _getPropertyAndCategoryList
+
+# XXX this class should be moved to Rule.py once new simulation is fully
+# integrated.
+class Rule(RuleMixin, MovementCollectionUpdaterMixin, Predicate):
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Declarative interfaces
+  zope.interface.implements(interfaces.IRule,
+                            interfaces.IDivergenceController,
+                            interfaces.IMovementCollectionUpdater,)
+
+  # Default Properties
+  property_sheets = (
+    PropertySheet.Base,
+    PropertySheet.XMLObject,
+    PropertySheet.CategoryCore,
+    PropertySheet.DublinCore,
+    PropertySheet.Task,
+    PropertySheet.Predicate,
+    PropertySheet.Reference,
+    PropertySheet.Version,
+    PropertySheet.Rule
+    )
+
+  security.declareProtected(Permissions.View, 'getDivergenceList')
+  def getDivergenceList(self, movement):
+    """
+    Returns a list of divergences of the movements provided
+    in delivery_or_movement.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+    """
+    if movement.getDelivery() is None:
+      return []
+    result_list = []
+    for divergence_tester in self._getDivergenceTesterList(
+      exclude_quantity=False):
+      result = divergence_tester.explain(movement)
+      if isinstance(result, (list, tuple)): # for compatibility
+        result_list.extend(result)
+      elif result is not None:
+        result_list.append(result)
+    return result_list
+
+class InvoicingRule(Rule):
+  """
+  Invoicing Rule expand simulation created by a order or delivery rule.
+  """
+  # CMF Type Definition
+  meta_type = 'ERP5 Invoicing Rule'
+  portal_type = 'Invoicing Rule'
+
+  # XXX this method is missing in interface.
+  def isOrderable(self, movement):
+    return 1
+
+  # XXX this method is missing in interface.
+  def isDeliverable(self, movement):
+    if movement.getSimulationState() in movement.getPortalDraftOrderStateList():
+      return 0
+    return 1
+
+  def _getMovementGenerator(self):
+    """
+    Return the movement generator to use in the expand process
+    """
+    return InvoicingRuleMovementGenerator()
+
+  def _getMovementGeneratorContext(self, context):
+    """
+    Return the movement generator context to use for expand
+    """
+    return context
+
+  def _getMovementGeneratorMovementList(self):
+    """
+    Return the movement lists to provide to the movement generator
+    """
+    return []
+
+  def _isProfitAndLossMovement(self, movement):
+    # For a kind of trade rule, a profit and loss movement lacks source
+    # or destination.
+    return (movement.getSource() is None or movement.getDestination() is None)
+
+class InvoicingRuleMovementGenerator(object):
+  def getGeneratedMovementList(self, context, movement_list=None,
+                                rounding=False):
+    """
+    Input movement list comes from order
+
+    XXX This implementation is very primitive, and does not support BPM,
+    i.e. business paths are not taken into account.
+    """
+    ret = []
+    for movement in [context.getParentValue(),]:
+      kw = _getPropertyAndCategoryList(movement)
+      simulation_movement = context.newContent(
+        portal_type=RuleMixin.movement_type,
+        temp_object=True,
+        **kw)
+      ret.append(simulation_movement)
+    return ret

bt5/erp5_simulation_core/DocumentTemplateItem/OrderRule.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SARL and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility 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
+# guarantees 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+"""
+XXX This file is experimental for new simulation implementation, and
+will replace OrderRule.
+"""
+
+import zope.interface
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet, interfaces
+from Products.ERP5.Document.Predicate import Predicate
+from Products.ERP5.mixin.rule import RuleMixin
+from Products.ERP5.mixin.movement_collection_updater import \
+     MovementCollectionUpdaterMixin
+from Products.ERP5.MovementCollectionDiff import _getPropertyAndCategoryList
+
+# XXX this class should be moved to Rule.py once new simulation is fully
+# integrated.
+class Rule(RuleMixin, MovementCollectionUpdaterMixin, Predicate):
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Declarative interfaces
+  zope.interface.implements(interfaces.IRule,
+                            interfaces.IDivergenceController,
+                            interfaces.IMovementCollectionUpdater,)
+
+  # Default Properties
+  property_sheets = (
+    PropertySheet.Base,
+    PropertySheet.XMLObject,
+    PropertySheet.CategoryCore,
+    PropertySheet.DublinCore,
+    PropertySheet.Task,
+    PropertySheet.Predicate,
+    PropertySheet.Reference,
+    PropertySheet.Version,
+    PropertySheet.Rule
+    )
+
+  security.declareProtected(Permissions.View, 'getDivergenceList')
+  def getDivergenceList(self, movement):
+    """
+    Returns a list of divergences of the movements provided
+    in delivery_or_movement.
+
+    movement -- a movement, a delivery, a simulation movement,
+                or a list thereof
+    """
+    if movement.getDelivery() is None:
+      return []
+    result_list = []
+    for divergence_tester in self._getDivergenceTesterList(
+      exclude_quantity=False):
+      result = divergence_tester.explain(movement)
+      if isinstance(result, (list, tuple)): # for compatibility
+        result_list.extend(result)
+      elif result is not None:
+        result_list.append(result)
+    return result_list
+
+class OrderRule(Rule):
+  """
+  Order Rule object make sure an Order in the simulation
+  is consistent with the real order
+
+  WARNING: what to do with movement split ?
+  """
+  # CMF Type Definition
+  meta_type = 'ERP5 Order Rule'
+  portal_type = 'Order Rule'
+
+  # XXX this method is missing in interface.
+  def isOrderable(self, movement):
+    return 1
+
+  # XXX this method is missing in interface.
+  def isDeliverable(self, movement):
+    if movement.getSimulationState() in movement.getPortalDraftOrderStateList():
+      return 0
+    return 1
+
+  def _getMovementGenerator(self):
+    """
+    Return the movement generator to use in the expand process
+    """
+    return OrderRuleMovementGenerator()
+
+  def _getMovementGeneratorContext(self, context):
+    """
+    Return the movement generator context to use for expand
+    """
+    return context
+
+  def _getMovementGeneratorMovementList(self):
+    """
+    Return the movement lists to provide to the movement generator
+    """
+    return []
+
+  def _isProfitAndLossMovement(self, movement):
+    # For a kind of trade rule, a profit and loss movement lacks source
+    # or destination.
+    return (movement.getSource() is None or movement.getDestination() is None)
+
+class OrderRuleMovementGenerator(object):
+  def getGeneratedMovementList(self, context, movement_list=None,
+                                rounding=False):
+    """
+    Input movement list comes from order
+
+    XXX This implementation is very primitive, and does not support BPM,
+    i.e. business paths are not taken into account.
+    """
+    order = context.getDefaultCausalityValue()
+    if order is None:
+      return []
+    ret = []
+    for movement in order.getMovementList(
+      portal_type=order.getPortalOrderMovementTypeList()):
+      kw = _getPropertyAndCategoryList(movement)
+      simulation_movement = context.newContent(
+        portal_type=RuleMixin.movement_type,
+        temp_object=True,
+        order_value=movement,
+        **kw)
+      ret.append(simulation_movement)
+    return ret

bt5/erp5_simulation_core/bt/description

+This business template contains python files that overrides existing files. Once TemplateTool supports installing documents whose class file exists in the same business template, all contents here should be merged into erp5_simulation business template.
\ No newline at end of file

bt5/erp5_simulation_core/bt/license

+GPL
\ No newline at end of file

bt5/erp5_simulation_core/bt/publication_url

+None
\ No newline at end of file

bt5/erp5_simulation_core/bt/revision

+1
\ No newline at end of file

bt5/erp5_simulation_core/bt/short_title

+None
\ No newline at end of file

bt5/erp5_simulation_core/bt/template_document_id_list

+InvoicingRule
+OrderRule
\ No newline at end of file

bt5/erp5_simulation_core/bt/template_format_version

+1
\ No newline at end of file

bt5/erp5_simulation_core/bt/template_update_business_template_workflow

+0
\ No newline at end of file

bt5/erp5_simulation_core/bt/template_update_tool

+0
\ No newline at end of file

bt5/erp5_simulation_core/bt/title

+erp5_simulation_core
\ No newline at end of file

bt5/erp5_simulation_core/bt/version

+0.1
\ No newline at end of file