- Business Process Modelling documents

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

product/ERP5/Document/BusinessProcess.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.ERP5Type.XMLObject import XMLObject
+from Products.ERP5.Document.Path import Path
+
+class BusinessProcess(Path, XMLObject):
+  """
+    The BusinessProcess class is a container class which is used
+    to describe business processes in the area of trade, payroll
+    and production.
+  """
+  meta_type = 'ERP5 Business Process'
+  portal_type = 'Business Process'
+  isPredicate = 1
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Declarative properties
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    , PropertySheet.Folder
+                    , PropertySheet.Comment
+                    , PropertySheet.Arrow
+                    )
+
+  # Access to path and states of the business process
+  security.declareProtected(Permissions.AccessContentsInformation, 'getPathValueList')
+  def getPathValueList(self, trade_phase, context=None, **kw):
+    """
+      Returns all Path of the current BusinessProcess which
+      are matching the given trade_phase and the optional context.
+
+      trade_phase -- a single trade phase category or a list of
+                      trade phases
+
+      context -- the context to search matching predicates for
+
+      **kw -- same parameters as for searchValues / contentValues
+    """
+    # Naive implementation to redo XXX using contentValues
+    if type(trade_phase) is type(''): # XXX - bad, use isinstance
+      trade_phase = (trade_phase,)
+    result = []
+    for document in self.contentValues(portal_type="Business Path"):
+      for phase in trade_phase:
+        if document.isMemberOf('trade_phase/' + phase): # XXX - not so good, use filter if possible
+          result.append(document)
+          break
+    return result
+
+  security.declareProtected(Permissions.AccessContentsInformation, 'getStateValueList')
+  def getStateValueList(self, *args, **kw):
+    """
+      Returns all states of the business process. The method
+      **kw parameters follows the API of searchValues / contentValues
+    """
+    # Naive implementation to redo XXX
+    kw['portal_type'] = "Business State"
+    return self.contentValues(*args, **kw)
+
+  # Access to path and states of the business process
+  def isCompleted(self, explanation):
+    """
+      True if all states are completed
+    """
+    for state in self.getStateValueList():
+      if not state.isCompleted(explanation):
+        return False
+    return True
+  
+  def isBuildable(self, explanation):
+    """
+      True if all any path is buildable
+    """
+    return len(self.getBuildablePathValueList(explanation)) != 0
+
+  def getBuildablePathValueList(self, explanation):
+    """
+      Returns the list of Business Path which are ready to 
+      be built
+    """
+    return filter(lambda x:x.isBuildable(explanation), self.getPathValueList())
+
+  def getCompletedStateValueList(self, explanation):
+    """
+      Returns the list of Business States which are finished
+    """
+    return filter(lambda x:x.isCompleted(explanation), self.getStateValueList())
+
+  def getPartiallyCompletedStateValueList(self, explanation):
+    """
+      Returns the list of Business States which are finished
+    """
+    return filter(lambda x:x.isPartiallyCompleted(explanation), self.getStateValueList())
+
+  def getLatestCompletedStateValue(self, explanation):
+    """
+      Returns the most advanced completed state
+    """
+    for state in self.getCompletedStateValueList(explanation):
+      for path in state.getPredecessorRelatedValueList():
+        if not path.isCompleted(explanation):
+          return state
+    return None
+
+  def getLatestPartiallyCompletedStateValue(self, explanation):
+    """
+      Returns the most advanced completed state
+    """
+    for state in self.getCompletedStateValueList(explanation):
+      for path in state.getPredecessorRelatedValueList():
+        if not path.isPartiallyCompleted(explanation):
+          return state
+    return None
+
+  def getLatestCompletedStateValueList(self, explanation):
+    """
+      Returns the most advanced completed state
+    """
+    result = []
+    for state in self.getCompletedStateValueList(explanation):
+      for path in state.getPredecessorRelatedValueList():
+        if not path.isCompleted(explanation):
+          result.append(state)
+    return result
+
+  def getLatestPartiallyCompletedStateValueList(self, explanation):
+    """
+      Returns the most advanced completed state
+    """
+    result = []
+    for state in self.getCompletedStateValueList(explanation):
+      for path in state.getPredecessorRelatedValueList():
+        if not path.isPartiallyCompleted(explanation):
+          result.append(state)
+    return result
+
+  def build(self, explanation):
+    """
+      Build whatever is buildable
+    """
+    for path in self.getBuildablePathValueList(explanation):
+      path.build(explanation)
\ No newline at end of file

product/ERP5/Document/BusinessState.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.ERP5Type.XMLObject import XMLObject
+
+class BusinessState(XMLObject):
+  """
+    The BusinessProcess class is a container class which is used
+    to describe business processes in the area of trade, payroll
+    and production.
+  """
+  meta_type = 'ERP5 Business State'
+  portal_type = 'Business State'
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Declarative properties
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    , PropertySheet.Folder
+                    , PropertySheet.Comment
+                    )
+
+  # Core API
+  def isCompleted(self, explanation):
+    """
+      If all path which reach this state are completed
+      then this state is completed
+    """
+    for path in self.getSuccessorRelatedValueList():
+      if not path.isCompleted(explanation):
+        return False
+    return True
+
+
+  def isPartiallyCompleted(self, explanation):
+    """
+      If all path which reach this state are partially completed
+      then this state is completed
+    """
+    for path in self.getSuccessorRelatedValueList():
+      if not path.isPartiallyCompleted(explanation):
+        return False
+    return True
+
+  # Duration calculation
+  def getExpectedCompletionDate(self, explanation):
+    """
+      Returns the expected completion date for this
+      state based on the explanation.
+    """
+
+  def getExpectedCompletionDuration(self, explanation):
+    """
+      Returns the expected completion duration for this
+      state.
+    """