DeliveryRootSimulationRule.py 4.07 KB
Newer Older
1
# -*- coding: utf-8 -*-
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
##############################################################################
#
# Copyright (c) 2010 Nexedi SA 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.
#
##############################################################################

29
import zope.interface
30
from AccessControl import ClassSecurityInfo
31
from Products.ERP5Type import Permissions, PropertySheet, interfaces
32 33
from Products.ERP5.mixin.rule import RuleMixin
from Products.ERP5.mixin.movement_generator import MovementGeneratorMixin
34 35
from Products.ERP5.mixin.movement_collection_updater import \
     MovementCollectionUpdaterMixin
36

Julien Muchembled's avatar
Julien Muchembled committed
37
class DeliveryRootSimulationRule(RuleMixin, MovementCollectionUpdaterMixin):
38
  """
39 40
  Delivery Rule object make sure an Delivery in the simulation
  is consistent with the real delivery
41

42 43
  WARNING: what to do with movement split ?
  """
44 45 46 47 48 49 50 51
  # CMF Type Definition
  meta_type = 'ERP5 Delivery Root Simulation Rule'
  portal_type = 'Delivery Root Simulation Rule'

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
  # 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
    )

  def _getMovementGenerator(self, context):
    """
    Return the movement generator to use in the expand process
    """
    return DeliveryRuleMovementGenerator(applied_rule=context, rule=self)

  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 DeliveryRuleMovementGenerator(MovementGeneratorMixin):

83
  def _getPortalDeliveryMovementTypeList(self):
84 85 86 87 88 89
    """
    Allow to override to use only some particular types of delivery lines

    # This is bad XXX-JPS - use use
    """
    return None
90

91 92 93 94 95 96 97
  def _getInputMovementList(self, movement_list=None, rounding=None):
    """Input movement list comes from delivery"""
    delivery = self._applied_rule.getDefaultCausalityValue()
    if delivery is None:
      return []
    else:
      result = []
98 99 100 101 102
      movement_kw = {}
      movement_type_list = self._getPortalDeliveryMovementTypeList()
      if movement_type_list:
        movement_kw["portal_type"] = movement_type_list
      for movement in delivery.getMovementList(**movement_kw):
103 104 105 106
        simulation_movement_list = movement.getDeliveryRelatedValueList()
        if not simulation_movement_list or self._applied_rule in (
            simulation_movement.getParentValue()
            for simulation_movement in simulation_movement_list):
107 108
          result.append(movement)
      return result