56 lines
1.8 KiB
PHP
56 lines
1.8 KiB
PHP
<?php
|
||
declare(strict_types=1);
|
||
/**
|
||
* @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
|
||
*
|
||
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
||
*
|
||
* @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\WorkflowEngine;
|
||
|
||
/**
|
||
* Interface IComplexOperation
|
||
*
|
||
* This interface represents an operator that is less generic and indicates
|
||
* that some of the tasks it does itself instead of relying on the engine.
|
||
* This includes:
|
||
*
|
||
* * registering listeners – the implementing app needs to ensure that the
|
||
* business logic registers listeners to the events it listens to. For example
|
||
* when direct storage access is required, adding a wrapper or listening to
|
||
* a specific one is required over usual file events.
|
||
*
|
||
* @package OCP\WorkflowEngine
|
||
*
|
||
* @since 18.0.0
|
||
*/
|
||
interface IComplexOperation extends IOperation {
|
||
|
||
/**
|
||
* As IComplexOperation chooses the triggering events itself, a hint has
|
||
* to be shown to the user so make clear when this operation is becoming
|
||
* active. This method returns such a translated string.
|
||
*
|
||
* Example: "When a file is accessed" (en)
|
||
*
|
||
* @since 18.0.0
|
||
*/
|
||
public function getTriggerHint(): string;
|
||
|
||
}
|