From 292f85b6138876d1918e2a9586e86cf3cae539e8 Mon Sep 17 00:00:00 2001
From: Romain Courteaud <romain@nexedi.com>
Date: Wed, 14 May 2008 07:58:29 +0000
Subject: [PATCH] Add a new constraint CategoryMembershipState, which can be
used to verify related document's state.
git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@20947 20353a03-c40f-0410-a6d1-a30d3c3de9de
---
.../Constraint/CategoryMembershipState.py | 78 +++++++++++++++++++
1 file changed, 78 insertions(+)
create mode 100644 product/ERP5Type/Constraint/CategoryMembershipState.py
diff --git a/product/ERP5Type/Constraint/CategoryMembershipState.py b/product/ERP5Type/Constraint/CategoryMembershipState.py
new file mode 100644
index 0000000000..ac71520a7f
--- /dev/null
+++ b/product/ERP5Type/Constraint/CategoryMembershipState.py
@@ -0,0 +1,78 @@
+##############################################################################
+#
+# Copyright (c) 2008 Nexedi SA and Contributors. All Rights Reserved.
+# Romain Courteaud <romain@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 Products.ERP5Type.Constraint.Constraint import Constraint
+from Products.ERP5Type.Utils import convertToUpperCase
+
+class CategoryMembershipState(Constraint):
+ """
+ This method check the category membership is in a
+ valid workflow state.
+ For example we can check if every Order has
+ a source validated.
+ Configuration exemple:
+ { 'id' : 'source',
+ 'description' : '',
+ 'type' : 'CategoryMembershipState',
+ 'portal_type' : ('Organisation', ),
+ 'base_category' : ('source',),
+ 'validation_state': ('validated', ),
+ },
+ """
+
+ def checkConsistency(self, obj, fixit=0):
+ """
+ This is the check method, we return a list of string,
+ each string corresponds to an error.
+ We are looking the definition of the constraing where
+ are defined the minimum and the maximum arity, and the
+ list of objects we wants to check the arity.
+ """
+ errors = []
+ # Retrieve values inside de PropertySheet (_constraints)
+ base_category = self.constraint_definition['base_category']
+ portal_type = self.constraint_definition['portal_type']
+ membership_list = obj.getValueList(base_category,
+ portal_type=portal_type)
+ state_var_list = self.constraint_definition.copy()
+ state_var_list.pop('portal_type')
+ state_var_list.pop('base_category')
+
+ for workflow_variable, valid_state_list in state_var_list.items():
+ for membership in membership_list:
+ method = getattr(membership,
+ 'get%s' % convertToUpperCase(workflow_variable))
+ current_state = method()
+ if current_state not in valid_state_list:
+ # Generate error message
+ error_message = "'%s' for object '%s' is '%s' which is not in " \
+ "'%s'" % (workflow_variable, membership.getRelativeUrl(),
+ current_state, str(valid_state_list))
+ # Add error
+ errors.append(self._generateError(obj, error_message))
+ return errors
--
2.30.9