InvoiceSimulationRule.py 4.25 KB
Newer Older
1 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
##############################################################################
#
# Copyright (c) 2009 Nexedi SARL 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 InvoicingRule.
"""

import zope.interface
from AccessControl import ClassSecurityInfo
from Products.ERP5Type import Permissions, PropertySheet, interfaces
35
from Products.ERP5Type.Core.Predicate import Predicate
36 37 38
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

41
class InvoiceSimulationRule(RuleMixin, MovementCollectionUpdaterMixin, Predicate):
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
42 43 44 45
  """
  Invoicing Rule expand simulation created by a order or delivery rule.
  """
  # CMF Type Definition
46 47
  meta_type = 'ERP5 Invoice Simulation Rule'
  portal_type = 'Invoice Simulation Rule'
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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
  # 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 InvoicingRuleMovementGenerator()

  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
94
class InvoicingRuleMovementGenerator(MovementGeneratorMixin):
95 96 97
  def getGeneratedMovementList(self, context, movement_list=None,
                                rounding=False):
    """
98 99
    In Invoice Simulation Rule, source should be source_administration
    of the input movement or its order's source. Same for destination.
100 101
    """
    ret = []
102
    rule = context.getSpecialiseValue()
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
103 104
    for input_movement, business_path in self \
            ._getInputMovementAndPathTupleList(context):
105 106
      kw = self._getPropertyAndCategoryList(input_movement, business_path,
                                            rule)
107
      kw.update({'order':None,'delivery':None})
108 109 110 111 112 113
      simulation_movement = context.newContent(
        portal_type=RuleMixin.movement_type,
        temp_object=True,
        **kw)
      ret.append(simulation_movement)
    return ret
Kazuhiko Shiozaki's avatar
Kazuhiko Shiozaki committed
114 115 116

  def _getInputMovementList(self, context):
    return [context.getParentValue(),]