TradeModelSimulationRule.py 4.14 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 32 33 34 35
##############################################################################
#
# 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.
"""
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
36
from Products.ERP5.mixin.rule import RuleMixin, MovementGeneratorMixin
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
37 38 39
from Products.ERP5.mixin.movement_collection_updater import \
     MovementCollectionUpdaterMixin

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

Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
  # 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
    )

70
  def _getMovementGenerator(self, context):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
71 72 73
    """
    Return the movement generator to use in the expand process
    """
74
    return TradeModelRuleMovementGenerator(applied_rule=context, rule=self)
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
75 76 77 78 79 80 81

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

82
  def _getMovementGeneratorMovementList(self, context):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
83 84 85 86 87 88 89 90 91 92 93
    """
    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):
94

95
  def _getInputMovementList(self, movement_list=None, rounding=False):
96 97
    simulation_movement = self._applied_rule.getParentValue()
    trade_model = simulation_movement.asComposedDocument()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
98

99
    if trade_model is None:
100
      return
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
101

102 103
    rule = self._applied_rule.getSpecialiseValue()
    for amount in simulation_movement.getAggregatedAmountList(
104 105 106 107
        # XXX add a 'trade_amount_generator' group type
        amount_generator_type_list=('Purchase Trade Condition',
                                    'Sale Trade Condition',
                                    'Trade Model Line')):
108 109 110
      yield self._applied_rule.newContent(
        portal_type=RuleMixin.movement_type, temp_object=True,
        **dict((k, v) for k, v in amount.__dict__.iteritems() if k[0] != '_'))