Blame view

sources/lib/public/backgroundjob/ijob.php 981 Bytes
6d9380f96   Cédric Dupont   Update sources OC...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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();
  }