From 3b4068a2d29ee5a575b167608b0f3bbd8c74d6e4 Mon Sep 17 00:00:00 2001
From: Daniel Hornung <d.hornung@indiscale.com>
Date: Fri, 4 Jun 2021 08:11:43 +0200
Subject: [PATCH] DOC: small fixes.
---
src/doc/development/structure.rst | 2 +-
src/main/java/org/caosdb/server/jobs/JobExecutionTime.java | 2 +-
src/main/java/org/caosdb/server/jobs/Schedule.java | 2 +-
.../java/org/caosdb/server/transaction/Transaction.java | 6 ++++++
4 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/src/doc/development/structure.rst b/src/doc/development/structure.rst
index f5d5cb8b..76616475 100644
--- a/src/doc/development/structure.rst
+++ b/src/doc/development/structure.rst
@@ -46,7 +46,7 @@ Transactions are explained in detail in the :ref:`Transactions and Schedules<tra
MySQL Backend
-------------
-The MySQL backend in CaosDB may be substituted by backends for, but at the time of writing this
+The MySQL backend in CaosDB may be substituted by other backends, but at the time of writing this
documentation, only MySQL (MariaDB is used for testing) is implemented. There are the following
main packages which handle the backend:
diff --git a/src/main/java/org/caosdb/server/jobs/JobExecutionTime.java b/src/main/java/org/caosdb/server/jobs/JobExecutionTime.java
index a336a13f..13570d1e 100644
--- a/src/main/java/org/caosdb/server/jobs/JobExecutionTime.java
+++ b/src/main/java/org/caosdb/server/jobs/JobExecutionTime.java
@@ -23,7 +23,7 @@
package org.caosdb.server.jobs;
/**
- * Not really a time (measured in seconds), but rather the executaion state.
+ * Not really a time (measured in seconds), but rather the execution stage.
*/
public enum JobExecutionTime {
INIT,
diff --git a/src/main/java/org/caosdb/server/jobs/Schedule.java b/src/main/java/org/caosdb/server/jobs/Schedule.java
index 4b17f7f1..6c28eaf9 100644
--- a/src/main/java/org/caosdb/server/jobs/Schedule.java
+++ b/src/main/java/org/caosdb/server/jobs/Schedule.java
@@ -90,7 +90,7 @@ public class Schedule {
/**
* Run all scheduled Jobs for the given entity.
*
- * Execution time: Either CHECK or what is given as jobclass annotation.
+ * Execution time: Either CHECK or what is given as jobclass' annotation.
*/
public void runJob(final EntityInterface entity, final Class<? extends Job> jobclass) {
List<ScheduledJob> jobs =
diff --git a/src/main/java/org/caosdb/server/transaction/Transaction.java b/src/main/java/org/caosdb/server/transaction/Transaction.java
index 2086e96d..7e5d4e16 100644
--- a/src/main/java/org/caosdb/server/transaction/Transaction.java
+++ b/src/main/java/org/caosdb/server/transaction/Transaction.java
@@ -232,6 +232,12 @@ public abstract class Transaction<C extends TransactionContainer> extends Abstra
}
}
+ /**
+ * Return the internal {@link Schedule} object.
+ * <p>
+ * The Schedule stores jobs which are also triggered by this transaction (see {@link execute()}
+ * for details).
+ */
public Schedule getSchedule() {
return this.schedule;
}
--
GitLab