Added open order functionality.

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@25495 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5/Document/OpenOrderRule.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi KK, Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability 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
+# garantees 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.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet, Interface
+from Products.ERP5.Document.Rule import Rule
+from Products.ERP5.Document.DeliveryRule import DeliveryRule
+from zLOG import LOG, WARNING
+from DateTime import DateTime
+
+
+class OpenOrderRule(DeliveryRule):
+  """
+  Order Rule object make sure an Order in the simulation
+  is consistent with the real order
+
+  WARNING: what to do with movement split ?
+  """
+  # CMF Type Definition
+  meta_type = 'ERP5 Open Order Rule'
+  portal_type = 'Open Order Rule'
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+  
+  __implements__ = ( Interface.Predicate,
+                     Interface.Rule )
+
+  # Default Properties
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    , PropertySheet.Task
+                    )
+
+  # Simulation workflow
+  security.declareProtected(Permissions.ModifyPortalContent, 'expand')
+  def expand(self, applied_rule, force=0, **kw):
+    """
+      Expands the Order to a new simulation tree.
+      expand is only allowed to modify a simulation movement if it doesn't
+      have a delivery relation yet.
+
+      If the movement is in ordered or planned state, has no delivered
+      child, and is not in order, it can be deleted.
+      Else, if the movement is in ordered or planned state, has no
+      delivered child, and is in order, it can be modified.
+      Else, it cannot be modified.
+    """
+    movement_type = 'Simulation Movement'
+    order = applied_rule.getDefaultCausalityValue()
+    if order is not None:
+      order_movement_list = order.getMovementList(
+        portal_type=order.getPortalOrderMovementTypeList())
+
+      for order_movement in order_movement_list:
+        last_simulation_movement = self._getLastSimulationMovementValue(applied_rule, order_movement)
+        if last_simulation_movement is not None:
+          schedule_start_date = last_simulation_movement.getStartDate()
+          schedule_list = self._getOrderDateScheduleTupleList(order_movement, schedule_start_date, **kw)
+        else:
+          # Because order's start_date might be matched with the periodicity.
+          order_start_date = order.getStartDate()
+          schedule_start_date = order_start_date-1
+          schedule_list = [date_pair
+                           for date_pair in self._getOrderDateScheduleTupleList(order_movement, schedule_start_date, **kw)
+                           if date_pair[0]>=order_start_date]
+
+        for start_date, stop_date in schedule_list:
+          property_dict = {'start_date':start_date, 'stop_date':stop_date}
+          property_dict = self._getExpandablePropertyDict(order_movement,
+                                                          property_dict)
+          simulation_movement = applied_rule.newContent(
+            portal_type=movement_type,
+            order_value=order_movement,
+            order_ratio=1,
+            delivery_ratio=1,
+            deliverable=1,
+            **property_dict
+            )
+
+      # Mark that expand finished.
+      applied_rule.setLastExpandSimulationState(order.getSimulationState())
+    # Pass to base class
+    Rule.expand(self, applied_rule, force=force, **kw)
+
+  security.declareProtected(Permissions.AccessContentsInformation, 'isStable')
+  def isStable(self, applied_rule):
+    """
+    Checks that the applied_rule is stable
+    """
+    LOG('OrderRule.isStable', WARNING, 'Not Implemented')
+    return 1
+
+  security.declareProtected(Permissions.AccessContentsInformation,
+                            'isDivergent')
+  def isDivergent(self, movement):
+    """
+    Checks that the movement is divergent
+    """
+    return Rule.isDivergent(self, movement)
+
+  def _getExpandablePropertyDict(self, order_movement, property_dict=None):
+    property_list = (
+      'title',
+      'reference',
+      'description',
+      'int_index',
+      'source',
+      'source_section',
+      'source_function',
+      'source_trade_list',
+      'destination',
+      'destination_section',
+      'destination_function',
+      'resource',
+      'variation_category_list',
+      'variation_property_dict',
+      'base_contribution_list',
+      'aggregate_list',
+      'price',
+      'price_currency',
+      'quantity',
+      'quantity_unit',
+      )
+    if property_dict is None:
+      property_dict = {}
+    for property_name in property_list:
+      if not property_name in property_dict:
+        property_dict[property_name] = order_movement.getProperty(property_name)
+    return property_dict
+
+  def _getLastSimulationMovementValue(self, applied_rule, order_movement):
+    result = applied_rule.searchFolder(order_uid=order_movement.getUid(),
+                                       sort_on=[('movement.start_date','DESC')])
+    if len(result)>0:
+      return result[0].getObject()
+    else:
+      return None
+
+  def _getOrderDateScheduleTupleList(self, order_movement, schedule_start_date,
+                                     calculation_base_date=None, **kw):
+    if calculation_base_date is None:
+      # This is NOW
+      calculation_base_date = DateTime()
+
+    getPeriodicityLineValueList = order_movement._getTypeBasedMethod('getPeriodicityLineValueList')
+    if getPeriodicityLineValueList is None:
+      raise RuntimeError, "Cannot find getPeriodicityLineValueList script"
+    schedule_stop_date = (calculation_base_date+
+                          order_movement.getForecastingTermDays())
+    if schedule_stop_date > order_movement.getStopDate():
+      schedule_stop_date = order_movement.getStopDate()
+    
+    periodicity_line_list = getPeriodicityLineValueList(schedule_start_date,
+                                                        schedule_stop_date)
+    result = []
+    for periodicity_line in periodicity_line_list:
+      result.extend(periodicity_line.getDatePeriodList(schedule_start_date,
+                                                       schedule_stop_date))
+    return result

product/ERP5/Document/PeriodicityLine.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi KK, Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability 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
+# garantees 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.
+#
+##############################################################################
+
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet
+from Products.ERP5.Document.Path import Path
+from Products.ERP5.Document.Alarm import PeriodicityMixin
+
+
+class PeriodicityLineMixin(PeriodicityMixin):
+  """
+  A class extends PeriodicityMixin to add term.
+  """
+
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  property_sheets = (PropertySheet.PeriodicityTerm,)
+
+  security.declareProtected(Permissions.AccessContentsInformation, 'getPeriodicityTermStopDate')
+  def getPeriodicityTermStopDate(self, start_date, default=None):
+    """Return periodicity term's stop_date by calculating periodicity term
+    length with a start_date argument and other own properties.
+    """
+    length_number = self.getPeriodicityTermLengthNumber()
+    time_scale = self.getPeriodicityTermTimeScale()
+    scope_type = self.getPeriodicityTermScopeType()
+
+    if scope_type:
+      method = self._getTypeBasedMethod('calculateScopeTypeStopDate')
+      if method is None:
+        raise RuntimeError, 'Type based method calculateScopeTypeStopDate does not exist.'
+      else:
+        return method(scope_type, start_date)
+    elif time_scale:
+      if time_scale=='day':
+        day = length_number
+        return start_date+day
+      else:
+        raise RuntimeError, 'Unknown time scale: %s' % time_scale
+    else:
+      return None
+
+class PeriodicityLine(Path, PeriodicityLineMixin):
+  """
+  A class defines how often an order is made.
+  """
+
+  meta_type = 'ERP5 Periodicity Line'
+  portal_type = 'Periodicity Line'
+  add_permission = Permissions.AddPortalContent
+  isPortalContent = 1
+  isRADContent = 1
+  isPredicate = 1
+
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  property_sheets = Path.property_sheets+(PropertySheet.Periodicity,
+                                          PropertySheet.PeriodicityTerm,
+                                          )
+
+  security.declareProtected(Permissions.AccessContentsInformation, 'getDatePeriodList')
+  def getDatePeriodList(self, from_date, to_date):
+    """
+    Returns a list of a tuple of start_date and stop_date.
+    """
+    effective_date = self.getEffectiveDate()
+    expiration_date = self.getExpirationDate()
+    result = []
+
+    if effective_date is not None and from_date < effective_date:
+      from_date = effective_date
+    if expiration_date is not None and to_date > expiration_date:
+      to_date = expiration_date
+
+    next_start_date = self.getNextPeriodicalDate(from_date)
+    while next_start_date <= to_date:
+      result.append((next_start_date,
+                     self.getPeriodicityTermStopDate(next_start_date)))
+      next_start_date = self.getNextPeriodicalDate(next_start_date)
+    return result

product/ERP5/PropertySheet/OpenOrder.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi KK, Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability 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
+# garantees 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.
+#
+##############################################################################
+
+class OpenOrder:
+  """
+  OpenOrder provides a way to order same items repeatedly. This property sheet
+  provides properties which are brought by the nature of repetition.
+  """
+
+  _properties = (
+    {   'id'          : 'forecasting_term_days',
+        'description' : 'A number of days to be forecasted.',
+        'type'        : 'int',
+        'mode'        : 'w' },
+    )

product/ERP5/PropertySheet/PeriodicityTerm.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi KK, Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability 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
+# garantees 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.
+#
+##############################################################################
+
+class PeriodicityTerm:
+  """
+  A property sheet extends Periodicity to add term.
+  """
+
+  _properties = (
+    {   'id'          : 'periodicity_term_scope_type',
+        'description' : 'A scope type pattern which is often used in the real world. ex. from today to the end of month, the end of year.',
+        'type'        : 'string',
+        'mode'        : 'w' },
+    {   'id'          : 'periodicity_term_time_scale',
+        'description' : 'A time scale of term. ex. day, month, year.',
+        'type'        : 'string',
+        'mode'        : 'w' },
+    {   'id'          : 'periodicity_term_length_number',
+        'description' : 'A length number of term without time scale.',
+        'type'        : 'int',
+        'mode'        : 'w' },
+    )