# -*- coding: utf-8 -*- ############################################################################## # # Copyright (c) 2008-2009 Nexedi SA and Contributors. All Rights Reserved. # Rafael Monnerat <rafael@nexedi.com> # Jean-Paul Smets <jp@nexedi.com> # # 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # ############################################################################## import zope.interface from AccessControl import ClassSecurityInfo from Products.ERP5.Document.Predicate import Predicate from Products.ERP5Type import Permissions, PropertySheet, interfaces from Products.ERP5.mixin.divergence_tester import DivergenceTesterMixin class StringDivergenceTester(Predicate, DivergenceTesterMixin): """ The purpose of this divergence tester is to check the consistency between delivery movement and simulation movement for a specific property. """ meta_type = 'ERP5 String Divergence Tester' portal_type = 'String Divergence Tester' add_permission = Permissions.AddPortalContent # Declarative security security = ClassSecurityInfo() security.declareObjectProtected(Permissions.AccessContentsInformation) # Declarative properties property_sheets = ( PropertySheet.Base , PropertySheet.XMLObject , PropertySheet.CategoryCore , PropertySheet.DublinCore , PropertySheet.DivergenceTester , PropertySheet.SolverSelection ) # Declarative interfaces zope.interface.implements( interfaces.IDivergenceTester, ) def _compare(self, prevision_movement, decision_movement): """ If prevision_movement and decision_movement don't match, it returns a list : (prevision_value, decision_value, message, mapping) """ tested_property = self.getTestedProperty() decision_value = decision_movement.getProperty(tested_property) if prevision_movement.isPropertyRecorded(tested_property): prevision_value = prevision_movement.getRecordedProperty(tested_property) else: prevision_value = prevision_movement.getProperty(tested_property) # XXX do we have configurable parameter for this divergence tester ? # like ambiguity... if decision_value != prevision_value: return ( prevision_value, decision_value, 'The value of ${prperty_name} is different between decision and prevision.', dict(property_name=tested_property)) return None def getUpdatablePropertyDict(self, prevision_movement, decision_movement): """ Returns a list of properties to update on decision_movement prevision_movement so that next call to compare returns True. prevision_movement -- a simulation movement (prevision) decision_movement -- a delivery movement (decision) """ tested_property = self.getTestedProperty() if prevision_movement.isPropertyRecorded(tested_property): prevision_value = prevision_movement.getRecordedProperty(tested_property) else: prevision_value = prevision_movement.getProperty(tested_property) return {tested_property:prevision_value} def accept(self, simulation_movement): """ Copies the properties handled by the divergence tester from the related delivery movement to simulation_movement. NOTE: the future existence of this method is still unknown because it is likely to be implemented in TargetSolver instead. """ raise NotImplementedError def adopt(self, simulation_movement): """ Copies the properties handled by the divergence tester from simulation_movement to the related delivery movement NOTE: the future existence of this method is still unknown because it is likely to be implemented in TargetSolver instead. """ raise NotImplementedError