Changeset 16012 for main/waeup.kofa/trunk/src/waeup/kofa/utils

Timestamp:

24 Feb 2020, 21:26:35 (5 years ago)

Author:

Henrik Bettermann

Message:

Implement BatchProcessor.checkCreateRequirements and
BatchProcessor.checkUpdateRequirements methods mainly
to protect course result lists of graduated student.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.py (modified) (5 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/utils/batching.py

@@ -196 +196 @@
         raise NotImplementedError('method not implemented')
 
+    def checkCreateRequirements(self, parent, row, site):
+        """Checks requirements the parent object must fulfill when
+        a new subobject is being created.
+
+        This method is not used in case of updating or removing objects.
+
+        Returns error messages as strings in case of requirement
+        problems.
+        """
+        return None
+
     def checkUpdateRequirements(self, obj, row, site):
         """Checks requirements the object must fulfill when being updated.
 
         This method is not used in case of deleting or adding objects.
+
+        Returns error messages as strings in case of requirement
+        problems.
+        """
+        return None
+
+
+    def checkRemoveRequirements(self, obj, row, site):
+        """Checks requirements the object must fulfill when being removed.
+
+        This method is not used in case of updating or adding objects.
 
         Returns error messages as strings in case of requirement
@@ -329 +351 @@
            record is stored in the pending data file.
 
+           The `BatchProcessor.checkCreateRequirements` method checks additional
+           requirements the parent object must fulfill before a new sububject
+           is being added. These requirements are not imposed by the data
+           type but the context of the object. For example, the course results
+           of graduated students must not changed by import, neither by 
+           creating nor updating or removing course tickets.
+
            Now `doImport` tries to add the new object with the data
            from the conversion dictionary. In some cases this
@@ -359 +388 @@
            a ``no such entry`` warning message is raised and a record is
            stored in the pending data file.
+
+           The `BatchProcessor.checkRemoveRequirements` method checks additional
+           requirements the object must fulfill before being removed.
+           These requirements are not imposed by the data type but the context
+           of the object. For example, the course results of graduated students
+           must not changed by import, neither by creating nor updating or
+           removing course tickets.
 
            Finally, `doImport` removes the existing object.
@@ -425 +461 @@
                         "This object already exists.")
                     continue
+                parent = self.getParent(row, site)
+                create_errors = self.checkCreateRequirements(parent, row, site)
+                if create_errors is not None:
+                    num_warns += 1
+                    self.writeFailedRow(
+                        failed_writer, string_row, create_errors)
+                    continue
                 obj = self.callFactory()
                 # Override all values in row, also
@@ -453 +496 @@
                         failed_writer, string_row,
                         "Cannot remove: no such entry")
+                    continue
+                obj = self.getEntry(row, site)
+                remove_errors = self.checkRemoveRequirements(obj, row, site)
+                if remove_errors is not None:
+                    num_warns += 1
+                    self.writeFailedRow(
+                        failed_writer, string_row, remove_errors)
                     continue
                 self.delEntry(row, site)