You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
88 lines
2.0 KiB
88 lines
2.0 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Joas Schilling <coding@schilljs.com> |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Robin Appelman <robin@icewind.nl> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* This code is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU Affero General Public License, version 3, |
|
* as published by the Free Software Foundation. |
|
* |
|
* This program is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU Affero General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU Affero General Public License, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
namespace OCP\BackgroundJob; |
|
use OCP\ILogger; |
|
|
|
/** |
|
* Interface IJob |
|
* |
|
* @package OCP\BackgroundJob |
|
* @since 7.0.0 |
|
*/ |
|
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 ILogger|null $logger |
|
* @since 7.0.0 |
|
*/ |
|
public function execute($jobList, ILogger $logger = null); |
|
|
|
/** |
|
* @param int $id |
|
* @since 7.0.0 |
|
*/ |
|
public function setId($id); |
|
|
|
/** |
|
* @param int $lastRun |
|
* @since 7.0.0 |
|
*/ |
|
public function setLastRun($lastRun); |
|
|
|
/** |
|
* @param mixed $argument |
|
* @since 7.0.0 |
|
*/ |
|
public function setArgument($argument); |
|
|
|
/** |
|
* 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 |
|
* @since 7.0.0 |
|
*/ |
|
public function getId(); |
|
|
|
/** |
|
* Get the last time this job was run as unix timestamp |
|
* |
|
* @return int |
|
* @since 7.0.0 |
|
*/ |
|
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 |
|
* @since 7.0.0 |
|
*/ |
|
public function getArgument(); |
|
}
|
|
|