summaryrefslogtreecommitdiffstats
path: root/lib/public/backgroundjob/ijob.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/backgroundjob/ijob.php')
-rw-r--r--lib/public/backgroundjob/ijob.php43
1 files changed, 43 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();
+}