# -*- coding: utf-8 -*- ############################################################################## # # Copyright (c) 2010 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. # ############################################################################## 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, MovementGeneratorMixin from Products.ERP5.mixin.movement_collection_updater import \ MovementCollectionUpdaterMixin class PaymentSimulationRule(RuleMixin, MovementCollectionUpdaterMixin, Predicate): """ Payment Rule generates payment simulation movement from invoice transaction simulation movements. """ # CMF Type Definition meta_type = 'ERP5 Payment Simulation Rule' portal_type = 'Payment Simulation Rule' # 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, context): """ Return the movement generator to use in the expand process """ return PaymentRuleMovementGenerator(applied_rule=context, rule=self) def _getMovementGeneratorContext(self, context): """ Return the movement generator context to use for expand """ return context def _getMovementGeneratorMovementList(self, context): """ 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 PaymentRuleMovementGenerator(MovementGeneratorMixin): def getGeneratedMovementList(self, movement_list=None, rounding=False): """ Input movement list comes from parent. XXX This implementation using Business Path, not Payment Condition. """ ret = [] rule = self._rule for input_movement, business_path in self \ ._getInputMovementAndPathTupleList(movement_list=movement_list, rounding=rounding): # Payment Rule does not work with Business Path if business_path is None: continue # Since we need to consider business_path only for bank movement, # not for payable movement, we pass None as business_path here. kw = self._getPropertyAndCategoryList(input_movement, None, rule) kw.update({'order':None, 'delivery':None}) quantity = kw.pop('quantity', 0) efficiency = business_path.getEfficiency() if efficiency: quantity *= efficiency start_date = business_path.getExpectedStartDate(input_movement) if start_date is not None: kw.update({'start_date':start_date}) stop_date = business_path.getExpectedStopDate(input_movement) if stop_date is not None: kw.update({'stop_date':stop_date}) # one for payable simulation_movement = self._applied_rule.newContent( portal_type=RuleMixin.movement_type, temp_object=True, quantity=-quantity, **kw) ret.append(simulation_movement) # one for bank kw.update({'source':business_path.getSource(), 'destination':business_path.getDestination(),}) simulation_movement = self._applied_rule.newContent( portal_type=RuleMixin.movement_type, temp_object=True, quantity=quantity, **kw) ret.append(simulation_movement) return ret def _getUpdatePropertyDict(self, input_movement): return {'delivery': None} def _getInputMovementList(self, movement_list=None, rounding=None): return [self._applied_rule.getParentValue(),]