nextcloud-server/lib/public/TextProcessing/IProvider2.php

<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2023 Marcel Klehr <mklehr@gmx.net>
 *
 * @author Marcel Klehr <mklehr@gmx.net>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */


namespace OCP\TextProcessing;

/**
 * This interface supersedes IProvider. It allows the system to learn
 * the provider's expected runtime and lets the provider know which user is running a task
 * @since 28.0.0
 * @template T of ITaskType
 * @template-extends IProvider<T>
 */
interface IProvider2 extends IProvider {
	/**
	 * @param ?string $userId the current user's id
	 * @since 28.0.0
	 */
	public function setUserId(?string $userId): string;

	/**
	 * @return int The expected average runtime of a task in seconds
	 * @since 28.0.0
	 */
	public function getExpectedRuntime(): int;
}