2 files changed, 125 insertions, 0 deletions
diff --git a/lib/public/backgroundjob/ijob.php b/lib/public/backgroundjob/ijob.php
new file mode 100644
index 00000000000..eaf11c4f684
--- /dev/null
+++ b/lib/public/backgroundjob/ijob.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * Copyright (c) 2014 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 {
+	/**
+	 * Run the background job with the registered argument
+	 *
+	 * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
+	 * @param \OC\Log $logger
+	 * @return void
+	 */
+	public function execute($jobList, $logger = null);
+
+	/**
+	 * Get the id of the background job
+	 * This id is determined by the job list when a job is added to the list
+	 *
+	 * @return int
+	 */
+	public function getId();
+
+	/**
+	 * Get the last time this job was run as unix timestamp
+	 *
+	 * @return int
+	 */
+	public function getLastRun();
+
+	/**
+	 * Get the argument associated with the background job
+	 * This is the argument that will be passed to the background job
+	 *
+	 * @return mixed
+	 */
+	public function getArgument();
+}
diff --git a/lib/public/backgroundjob/ijoblist.php b/lib/public/backgroundjob/ijoblist.php
new file mode 100644
index 00000000000..c9b546605b8
--- /dev/null
+++ b/lib/public/backgroundjob/ijoblist.php
@@ -0,0 +1,82 @@
+<?php
+/**
+ * Copyright (c) 2014 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 {
+	/**
+	 * Add a job to the list
+	 *
+	 * @param \OCP\BackgroundJob\IJob |string $job
+	 * @param mixed $argument The argument to be passed to $job->run() when the job is exectured
+	 * @param string $job
+	 * @return void
+	 */
+	public function add($job, $argument = null);
+
+	/**
+	 * Remove a job from the list
+	 *
+	 * @param IJob $job
+	 * @param mixed $argument
+	 * @return void
+	 */
+	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 to the current time
+	 *
+	 * @param \OCP\BackgroundJob\IJob $job
+	 * @return void
+	 */
+	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
+	 * @return void
+	 */
+	public function setLastRun($job);
+}