DeliverySimulationRule.py 3.76 KB
Newer Older
1
# -*- coding: utf-8 -*-
2 3
##############################################################################
#
4
# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
#
# 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
30
will replace DeliveryRule.
31 32 33 34 35 36
"""

import zope.interface
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, interfaces
from Products.ERP5.Document.Predicate import Predicate
Aurel's avatar
Aurel committed
37
from Products.ERP5.mixin.rule import RuleMixin, MovementGeneratorMixin
38 39 40
from Products.ERP5.mixin.movement_collection_updater import \
     MovementCollectionUpdaterMixin

41
class DeliverySimulationRule(RuleMixin, MovementCollectionUpdaterMixin, Predicate):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
42
  """
43 44 45 46
  Delivery Rule object make sure an Delivery in the simulation
  is consistent with the real delivery

  WARNING: what to do with movement split ?
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
47 48
  """
  # CMF Type Definition
49 50
  meta_type = 'ERP5 Delivery Simulation Rule'
  portal_type = 'Delivery Simulation Rule'
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
51

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
  # 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
    )

74
  def _getMovementGenerator(self, context):
75 76 77
    """
    Return the movement generator to use in the expand process
    """
78
    return DeliveryRuleMovementGenerator(applied_rule=context, rule=self)
79 80 81 82 83 84 85

  def _getMovementGeneratorContext(self, context):
    """
    Return the movement generator context to use for expand
    """
    return context

86
  def _getMovementGeneratorMovementList(self, context):
87 88 89 90 91 92 93 94 95 96
    """
    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)

97
class DeliveryRuleMovementGenerator(MovementGeneratorMixin):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
98

99 100 101
  def _getUpdatePropertyDict(self, input_movement):
    # Override default mixin implementation
    return {'order': None,
102
            'delivery': None,}
103 104 105

  def _getInputMovementList(self, movement_list=None, rounding=None):
    return [self._applied_rule.getParentValue(),]