document.erp5.TradeModelSimulationRule.py 4.77 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
##############################################################################
#
# 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
25
# Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
26 27
#
##############################################################################
28

29
import zope.interface
30
from AccessControl import ClassSecurityInfo
31
from Acquisition import aq_base
32 33
from Products.ERP5Type import Permissions, PropertySheet
from erp5.component.mixin.RuleMixin import RuleMixin
34
from erp5.component.mixin.MovementGeneratorMixin import MovementGeneratorMixin
35
from erp5.component.mixin.MovementCollectionUpdaterMixin import \
36
     MovementCollectionUpdaterMixin
37 38 39
from erp5.component.interface.IRule import IRule
from erp5.component.interface.IDivergenceController import IDivergenceController
from erp5.component.interface.IMovementCollectionUpdater import IMovementCollectionUpdater
40

41 42 43
@zope.interface.implementer(IRule,
                            IDivergenceController,
                            IMovementCollectionUpdater,)
Julien Muchembled's avatar
Julien Muchembled committed
44
class TradeModelSimulationRule(RuleMixin, MovementCollectionUpdaterMixin):
45
  """
46
    Rule for Trade Model
47 48 49 50 51 52 53 54
  """
  # CMF Type Definition
  meta_type = 'ERP5 Trade Model Simulation Rule'
  portal_type = 'Trade Model Simulation Rule'

  # Declarative security
  security = ClassSecurityInfo()
  security.declareObjectProtected(Permissions.AccessContentsInformation)
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

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

82
  def _getUpdatePropertyDict(self, input_movement):
83
    return {'causality': input_movement.getCausalityList(),
84
            'delivery': None,
85 86 87
            # XXX shouldn't we create a tester for price instead ?
            'price': input_movement.getPrice()}

88 89
  def _getInputMovementList(self, movement_list=None, rounding=False):
    simulation_movement = self._applied_rule.getParentValue()
90 91
    portal = self._applied_rule.getPortalObject()
    amount_list = simulation_movement.getAggregatedAmountList(
92 93 94
      # List of types passed to simulation_movement.asComposedDocument()
      # it needs to include portal types of all 'amount_generator*' groups:
      amount_generator_type_list=portal.getPortalAmountGeneratorAllTypeList(0))
95
    input_movement = aq_base(simulation_movement).__of__(self._applied_rule)
96
    for amount in amount_list:
97 98 99
      # Do not ignore amount with price = 0 (such behaviour can be obtained by
      # specifying a predicate on the amount generator line/cell).
      if amount.getResource():
100 101
        # FIXME: Is it the right way to have source/destination and other
        #        non-Amount properties set on the generated movement ?
102
        movement = input_movement.asContext(**{k: v
103
            for k, v in amount.__dict__.iteritems()
104
            if k[0] != '_' and k != 'categories'})
105 106 107 108 109 110
        base_category_set = set(amount.getBaseCategoryList())
        base_category_set.remove('price_currency') # XXX
        movement._setCategoryMembership(base_category_set,
                                        amount.getCategoryList(),
                                        base=True)
        yield movement