From 27f8a4eb30da823b24cede54720878138e887034 Mon Sep 17 00:00:00 2001
From: Timm Fitschen <t.fitschen@indiscale.com>
Date: Mon, 27 Sep 2021 13:35:44 +0200
Subject: [PATCH] DOC: add more doc strings

---
 .../grpc/EntityTransactionServiceImpl.java    | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/src/main/java/org/caosdb/server/grpc/EntityTransactionServiceImpl.java b/src/main/java/org/caosdb/server/grpc/EntityTransactionServiceImpl.java
index e83e89c7..9b5b6fc1 100644
--- a/src/main/java/org/caosdb/server/grpc/EntityTransactionServiceImpl.java
+++ b/src/main/java/org/caosdb/server/grpc/EntityTransactionServiceImpl.java
@@ -470,6 +470,13 @@ public class EntityTransactionServiceImpl extends EntityTransactionServiceImplBa
     return Integer.parseInt(id);
   }
 
+  /**
+   * Handle read-only transactions.
+   *
+   * @param request
+   * @return
+   * @throws Exception
+   */
   public MultiTransactionResponse retrieve(final MultiTransactionRequest request) throws Exception {
     final MultiTransactionResponse.Builder builder = MultiTransactionResponse.newBuilder();
     final RetrieveContainer container =
@@ -570,14 +577,25 @@ public class EntityTransactionServiceImpl extends EntityTransactionServiceImplBa
     return System.currentTimeMillis();
   }
 
+  /**
+   * Handle all entity transactions.
+   *
+   * @param request
+   * @return
+   * @throws Exception
+   */
   public MultiTransactionResponse transaction(final MultiTransactionRequest request)
       throws Exception {
     if (request.getRequestsCount() > 0) {
+      // we only test the first request and raise errors when subsequent sub-transactions do not
+      // fit.
       final WrappedRequestsCase requestCase = request.getRequests(0).getWrappedRequestsCase();
       switch (requestCase) {
         case RETRIEVE_REQUEST:
+          // Handle read-only transactions.
           return retrieve(request);
         default:
+          // Handle mixed-writed transactions.
           return write(request);
       }
     } else {
@@ -586,6 +604,13 @@ public class EntityTransactionServiceImpl extends EntityTransactionServiceImplBa
     }
   }
 
+  /**
+   * Handle mixed-write transactions.
+   *
+   * @param requests
+   * @return
+   * @throws Exception
+   */
   private MultiTransactionResponse write(final MultiTransactionRequest requests) throws Exception {
     final MultiTransactionResponse.Builder builder = MultiTransactionResponse.newBuilder();
     final WritableContainer container =
-- 
GitLab