#86 Logs

* adds log detail support for compensation state and action

konova/models/object.py

@@ -132,6 +132,23 @@ class BaseObject(BaseResource):
 
             self.save()
 
+    def mark_as_edited(self, performing_user: User, edit_comment: str = None):
+        """ In case the object or a related object changed the log history needs to be updated
+
+        Args:
+            performing_user (User): The user which performed the editing action
+            request (HttpRequest): The used request for this action
+            edit_comment (str): Additional comment for the log entry
+
+        Returns:
+
+        """
+        edit_action = UserActionLogEntry.get_edited_action(performing_user, edit_comment)
+        self.modified = edit_action
+        self.log.add(edit_action)
+        self.save()
+        return edit_action
+
     def add_log_entry(self, action: UserAction, user: User, comment: str):
         """ Wraps adding of UserActionLogEntry to log
 
@@ -262,25 +279,18 @@ class RecordableObjectMixin(models.Model):
 
         return action
 
-    def mark_as_edited(self, performing_user: User, request: HttpRequest = None, edit_comment: str = None, reset_recorded: bool = True):
-        """ In case the object or a related object changed, internal processes need to be started, such as
-        unrecord and uncheck
+    def unrecord(self, performing_user: User, request: HttpRequest = None):
+        """ Unrecords a dataset
 
         Args:
             performing_user (User): The user which performed the editing action
             request (HttpRequest): The used request for this action
-            edit_comment (str): Additional comment for the log entry
-            reset_recorded (bool): Whether the record-state of the object should be reset
 
         Returns:
 
         """
-        edit_action = UserActionLogEntry.get_edited_action(performing_user, edit_comment)
-        self.modified = edit_action
-        self.log.add(edit_action)
-        self.save()
-
-        if self.recorded and reset_recorded:
+        action = None
+        if self.recorded:
             action = self.set_unrecorded(performing_user)
             self.log.add(action)
             if request:
@@ -288,7 +298,7 @@ class RecordableObjectMixin(models.Model):
                     request,
                     CHECKED_RECORDED_RESET
                 )
-        return edit_action
+        return action
 
     @abstractmethod
     def is_ready_for_publish(self) -> bool: