Initial revision of interfaces which we be used for Open Order and SImulation in general

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

product/ERP5/Document/OpenOrder.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# 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 Globals import InitializeClass, PersistentMapping
+from AccessControl import ClassSecurityInfo
+
+from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
+from Products.ERP5.Document.Delivery import Delivery
+
+class OpenOrder(Delivery):
+  """
+    An OpenOrder is a collection of Open Order Lines
+  """
+  meta_type = 'ERP5 Open Order'
+  portal_type = 'Open Order'
+  isPredicate = 1 # XXX - Why ?
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Declarative interfaces
+  __implements__ = (Interface.Expandable, Interface.OpenOrderExpander)
+
+  # Declarative properties
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    , PropertySheet.Folder
+                    , PropertySheet.Comment
+                    , PropertySheet.Arrow
+                    , PropertySheet.Order
+                    )
+
+  # Expandable Interface Implementation
+  def expand(self, *args, **kw):
+    """
+      Any Open Order Line / Open Order Cell which does not relate
+      (aggregate) to a Subscription Item must be expanded
+      through the default rule. 
+
+      What would be nice is to use the SubscriptionItemRule to expand
+      lines one by one so that an Item can be used at any time.
+      expansion logic is provided by the OpenOrder or by the 
+      SubscriptionItem
+
+      Others are expanded by their Item
+    """
+    
+  security.declarePrivate('expandOpenOrderRule')
+  def expandOpenOrderRule(self, applied_rule_id=None, force=0, **kw):
+    """
+      Provides the default implementation of expand for Open Orders
+    """
+

product/ERP5/Document/OpenOrderCell.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# 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 Globals import InitializeClass, PersistentMapping
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet, Constraint, Interface
+from Products.ERP5.Document.SupplyCell import SupplyCell
+
+class OpenOrderCell(SupplyCell):
+    """
+      A OpenOrderCell allows to define specific quantities
+      for each variation of a resource in an Open Order Line.
+    """
+    meta_type = 'ERP5 Open Order Cell'
+    portal_type = 'Open Order Cell'
+    add_permission = Permissions.AddPortalContent
+    isPortalContent = 1
+    isRADContent = 1
+
+    # Declarative security
+    security = ClassSecurityInfo()
+    security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+    # Declarative interfaces
+    __implements__ = ( Interface.Variated, )
+
+    # Declarative properties
+    property_sheets = ( PropertySheet.Base
+                      , PropertySheet.CategoryCore
+                      , PropertySheet.Amount
+                      , PropertySheet.Task
+                      , PropertySheet.Movement
+                      , PropertySheet.Price
+                      , PropertySheet.SupplyLine
+                      , PropertySheet.Discount
+                      , PropertySheet.Path
+                      , PropertySheet.FlowCapacity
+                      , PropertySheet.Predicate
+                      , PropertySheet.MappedValue
+                      , PropertySheet.Reference
+                      )
+

product/ERP5/Document/OpenOrderLine.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# 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, Constraint, Interface
+from Products.ERP5.Document.SupplyLine import SupplyLine
+
+from zLOG import LOG
+
+class OpenOrderLine(SupplyLine):
+    """
+      An Open Order Line is a Supply Line with additional
+      properties to define repeatability
+    """
+    meta_type = 'ERP5 Open Order Line'
+    portal_type = 'Open Order Line'
+    add_permission = Permissions.AddPortalContent
+    isPortalContent = 1
+    isRADContent = 1
+    isPredicate = 1
+
+    # Declarative security
+    security = ClassSecurityInfo()
+    security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+    # Declarative interfaces
+    __implements__ = ( Interface.Variated,
+                       Interface.Predicate )
+
+    # Declarative properties
+    property_sheets = ( PropertySheet.Base
+                      , PropertySheet.XMLObject
+                      , PropertySheet.CategoryCore
+                      , PropertySheet.Amount
+                      , PropertySheet.Task
+                      , PropertySheet.Arrow
+                      , PropertySheet.Movement
+                      , PropertySheet.Price
+                      , PropertySheet.SupplyLine
+                      , PropertySheet.VariationRange
+                      , PropertySheet.Path
+                      , PropertySheet.FlowCapacity
+                      , PropertySheet.Predicate
+                      , PropertySheet.Comment
+                      )
+

product/ERP5/Interface/Expandable.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# 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 Interface import Interface
+
+class Expandable(Interface):
+  """
+    An Expandable class provides methods which trigger
+    the generation of a root applied rule in the simulation
+    and its expansion.
+  """
+
+  def expand(self, applied_rule_id=None, force=0, activate_kw=None, **kw):
+    """
+      Expand the current Expandable class into the similation
+    """

product/ERP5/Interface/OpenOrderExpander.py

+##############################################################################
+#
+# Copyright (c) 2009 Nexedi SA and Contributors. All Rights Reserved.
+#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
+#
+# 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 Interface import Interface
+
+class OpenOrderExpander(Interface):
+  """
+    Any class capable of expanding an Open Order Rule
+    follows the OpenOrderExpander interface
+  """
+
+  def expandOpenOrderRule(applied_rule_id=None, force=0, **kw):
+    """
+      This method is invoked by OpenOrderRule to delegate
+      the default implementation of expand
+    """