Add IParallelAwareJob interface

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

2 files changed, 22 insertions, 2 deletions

diff --git a/lib/public/BackgroundJob/IParallelAwareJob.php b/lib/public/BackgroundJob/IParallelAwareJob.php
new file mode 100644
index 00000000000..9374901e09f
--- /dev/null
+++ b/lib/public/BackgroundJob/IParallelAwareJob.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace OCP\BackgroundJob;
+
+interface IParallelAwareJob {
+	/**
+	 * Set this to false to prevent two Jobs from the same class from running in parallel
+	 *
+	 * @param bool $allow
+	 * @return void
+	 * @since 27.0.0
+	 */
+	public function setAllowParallelRuns(bool $allow): void;
+
+	/**
+	 * @return bool
+	 * @since 27.0.0
+	 */
+	public function getAllowParallelRuns(): bool;
+}
diff --git a/lib/public/BackgroundJob/Job.php b/lib/public/BackgroundJob/Job.php
index 89ea41381c9..c1e129f1221 100644
--- a/lib/public/BackgroundJob/Job.php
+++ b/lib/public/BackgroundJob/Job.php
@@ -38,7 +38,7 @@ use Psr\Log\LoggerInterface;
  *
  * @since 15.0.0
  */
-abstract class Job implements IJob {
+abstract class Job implements IJob, IParallelAwareJob {
 	protected int $id = 0;
 	protected int $lastRun = 0;
 	protected $argument;
@@ -145,7 +145,7 @@ abstract class Job implements IJob {
 	 * @return void
 	 * @since 27.0.0
 	 */
-	public function setAllowParallelRuns(bool $allow) {
+	public function setAllowParallelRuns(bool $allow): void {
 		$this->allowParallelRuns = $allow;
 	}