summaryrefslogtreecommitdiffstats
path: root/lib/public/backgroundjob
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/backgroundjob')
-rw-r--r--lib/public/backgroundjob/ijob.php29
-rw-r--r--lib/public/backgroundjob/ijoblist.php73
2 files changed, 102 insertions, 0 deletions
diff --git a/lib/public/backgroundjob/ijob.php b/lib/public/backgroundjob/ijob.php
new file mode 100644
index 00000000000..c427b50401d
--- /dev/null
+++ b/lib/public/backgroundjob/ijob.php
@@ -0,0 +1,29 @@
+<?php
+/**
+ * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\BackgroundJob;
+
+interface IJob {
+ /**
+ * @param \OCP\BackgroundJob\IJobList $jobList
+ * @param \OC\Log $logger
+ */
+ public function execute($jobList, $logger = null);
+
+ public function setId($id);
+
+ public function setLastRun($lastRun);
+
+ public function setArgument($argument);
+
+ public function getId();
+
+ public function getLastRun();
+
+ public function getArgument();
+}
diff --git a/lib/public/backgroundjob/ijoblist.php b/lib/public/backgroundjob/ijoblist.php
new file mode 100644
index 00000000000..7e80d51755b
--- /dev/null
+++ b/lib/public/backgroundjob/ijoblist.php
@@ -0,0 +1,73 @@
+<?php
+/**
+ * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\BackgroundJob;
+
+interface IJobList {
+ /**
+ * @param \OCP\BackgroundJob\IJob |string $job
+ * @param mixed $argument
+ */
+ public function add($job, $argument = null);
+
+ /**
+ * @param \OCP\BackgroundJob\IJob|string $job
+ * @param mixed $argument
+ */
+ public function remove($job, $argument = null);
+
+ /**
+ * check if a job is in the list
+ *
+ * @param $job
+ * @param mixed $argument
+ * @return bool
+ */
+ public function has($job, $argument);
+
+ /**
+ * get all jobs in the list
+ *
+ * @return \OCP\BackgroundJob\IJob[]
+ */
+ public function getAll();
+
+ /**
+ * get the next job in the list
+ *
+ * @return \OCP\BackgroundJob\IJob
+ */
+ public function getNext();
+
+ /**
+ * @param int $id
+ * @return \OCP\BackgroundJob\IJob
+ */
+ public function getById($id);
+
+ /**
+ * set the job that was last ran
+ *
+ * @param \OCP\BackgroundJob\IJob $job
+ */
+ public function setLastJob($job);
+
+ /**
+ * get the id of the last ran job
+ *
+ * @return int
+ */
+ public function getLastJob();
+
+ /**
+ * set the lastRun of $job to now
+ *
+ * @param \OCP\BackgroundJob\IJob $job
+ */
+ public function setLastRun($job);
+}