nextcloud/lib/public/BackgroundJob/IJob.php

<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCP\BackgroundJob;

/**
 * This interface represents a background job run with cron
 *
 * To implement a background job, you must extend either \OCP\BackgroundJob\Job,
 * \OCP\BackgroundJob\TimedJob or \OCP\BackgroundJob\QueuedJob
 *
 * @since 7.0.0
 * @since 25.0.0 deprecated `execute()` method in favor of `start()`
 * @since 33.0.0 removed deprecated `execute()` method
 */
interface IJob {
	/**
	 * @since 24.0.0
	 */
	public const TIME_INSENSITIVE = 0;
	/**
	 * @since 24.0.0
	 */
	public const TIME_SENSITIVE = 1;

	/**
	 * Start the background job with the registered argument
	 *
	 * This methods will take care of running the background job, of initializing
	 * the state and cleaning up the job list after running the job.
	 *
	 * For common background job scenario, you will want to use TimedJob or QueuedJob
	 * instead of overwriting this method.
	 *
	 * @param IJobList $jobList The job list that manages the state of this job
	 * @since 25.0.0
	 */
	public function start(IJobList $jobList): void;

	/**
	 * @since 7.0.0
	 * @since 33.0.0 Parameter $id changed from int to string
	 */
	public function setId(string $id): void;

	/**
	 * @since 7.0.0
	 */
	public function setLastRun(int $lastRun): void;

	/**
	 * @param mixed $argument
	 * @since 7.0.0
	 */
	public function setArgument(mixed $argument): void;

	/**
	 * Get the id of the background job
	 * This id is determined by the job list when a job is added to the list
	 *
	 * @since 7.0.0
	 * @since 33.0.0 The return type changed from int to string
	 */
	public function getId(): string;

	/**
	 * Get the last time this job was run as unix timestamp
	 *
	 * @since 7.0.0
	 */
	public function getLastRun(): int;

	/**
	 * Get the argument associated with the background job
	 * This is the argument that will be passed to the background job
	 *
	 * @since 7.0.0
	 */
	public function getArgument(): mixed;
}