OrderRule.py 4.35 KB
Newer Older
1 2
##############################################################################
#
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
3
# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
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 29 30 31 32 33 34 35 36 37 38
#
# 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
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
39
from Products.ERP5.mixin.movement_generator import MovementGeneratorMixin
40

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
41 42 43 44 45 46 47 48 49 50 51
class OrderRule(RuleMixin, MovementCollectionUpdaterMixin, Predicate):
  """
  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'

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 83 84 85 86 87 88 89 90 91 92 93 94 95 96
  # 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
    )

  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)

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
97
class OrderRuleMovementGenerator(MovementGeneratorMixin):
98 99 100 101 102 103
  def getGeneratedMovementList(self, context, movement_list=None,
                                rounding=False):
    """
    Input movement list comes from order
    """
    ret = []
104
    rule = context.getSpecialiseValue()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
105 106
    for input_movement, business_path in self \
            ._getInputMovementAndPathTupleList(context):
107 108
      kw = self._getPropertyAndCategoryList(input_movement, business_path,
                                            rule)
109 110 111
      simulation_movement = context.newContent(
        portal_type=RuleMixin.movement_type,
        temp_object=True,
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
112
        order_value=input_movement,
113 114 115
        **kw)
      ret.append(simulation_movement)
    return ret
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
116 117 118 119 120 121 122 123 124

  def _getInputMovementList(self, context):
    """Input movement list comes from order"""
    order = context.getDefaultCausalityValue()
    if order is None:
      return []
    else:
      return order.getMovementList(
        portal_type=order.getPortalOrderMovementTypeList())