Changeset 12883 for main/waeup.kofa/trunk/src/waeup/kofa/accesscodes

Timestamp:

25 Apr 2015, 06:13:18 (10 years ago)

Author:

Henrik Bettermann

Message:

More docs.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/batching.py (modified) (3 diffs)

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

@@ -34 +34 @@
 
 class AccessCodeBatchProcessor(BatchProcessor):
-    """A batch processor for IAccessCodeBatch objects.
+    """The Access Code Batch Processor imports containers for access codes.
+    It does not import their content. There is nothing special about this
+    processor.
     """
     grok.implements(IBatchProcessor)
@@ -85 +87 @@
 
 class AccessCodeProcessor(BatchProcessor):
-    """A batch processor for IAccessCode objects.
+    """The Access Code Processor imports access codes (ac) into their
+    batches. Localization requires the `representation` of the ac
+    (object id) as well as  `batch_prefix` and `batch_num` to find
+    the parent container (the batch).
+
+    Access codes follow a workflow. The `checkConversion` method validates
+    the workflow `state` and `transition` in row. `checkUpdateRequirements`
+    checks if the transition is allowed. This depends on the context.
     """
     grok.implements(IBatchProcessor)
@@ -136 +145 @@
     def addEntry(self, obj, row, site):
         parent = self.getParent(row, site)
-        obj.batch_serial = row['batch_serial']
-        obj.random_num = row['random_num']
         parent[row['representation']] = obj
         return