TradeModelSimulationRule.py 5.35 KB
Newer Older
1
# -*- coding: utf-8 -*-
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
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 29 30 31
##############################################################################
#
# 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.
#
##############################################################################
"""
XXX This file is experimental for new simulation implementation, and
will replace DeliveryRule.
"""
32
from zLOG import LOG
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
33 34 35 36 37 38 39 40 41
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.mixin.movement_generator import MovementGeneratorMixin

42
class TradeModelSimulationRule(RuleMixin, MovementCollectionUpdaterMixin, Predicate):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
43 44 45 46
  """
    Rule for Trade Model
  """
  # CMF Type Definition
47 48
  meta_type = 'ERP5 Trade Model Simulation Rule'
  portal_type = 'Trade Model Simulation Rule'
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
49

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
50 51 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 97 98 99 100 101
  # 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 TradeModelRuleMovementGenerator()

  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 TradeModelRuleMovementGenerator(MovementGeneratorMixin):
  def getGeneratedMovementList(self, context, movement_list=None,
                                rounding=False):
    """
    Generates list of movements
    """
    movement_list = []
102
    trade_condition = context.getTradeConditionValue() # XXX-JPS - which API ?
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
103 104 105 106 107 108 109 110 111
    business_process = context.getBusinessProcessValue()

    if trade_condition is None or business_process is None:
      return movement_list

    context_movement = context.getParentValue()
    for amount in trade_condition.getAggregatedAmountList(context_movement):
      # business path specific
      business_path_list = business_process.getPathValueList(
112
          trade_phase=amount.getTradePhaseList()) # Why a list of trade phases ? XXX-JPS
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
113 114 115 116 117 118 119 120 121 122 123
      if len(business_path_list) == 0:
        raise ValueError('Cannot find Business Path')

      if len(business_path_list) != 1:
        raise NotImplementedError('Only one Business Path is supported')

      business_path = business_path_list[0]

      kw = self._getPropertyAndCategoryList(context_movement, business_path)

      # rule specific
124 125
      kw['price'] = amount.getPrice() or amount.getEfficiency()
      kw['resource'] = amount.getProperty('resource_list') # Inconsistent... list and not list XXX-JPS
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
126 127 128 129 130 131 132
      kw['reference'] = amount.getProperty('reference')
      kw['quantity'] = amount.getProperty('quantity')
      kw['base_application'] = amount.getProperty(
          'base_application_list')
      kw['base_contribution'] = amount.getProperty(
          'base_contribution_list')

133 134 135 136 137
      LOG('kw before setting order and delivery to None', 0, repr(kw))
      kw['order'] = None
      kw['delivery'] = None # Where does this come from ??? XXX-JPS - Why not None ?
                            # XXX-JPS Way too many properties are copied

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
138 139 140 141 142 143 144
      simulation_movement = context.newContent(
        portal_type=RuleMixin.movement_type,
        temp_object=True,
        **kw)
      movement_list.append(simulation_movement)

    return movement_list