nextcloud/lib/public/WorkflowEngine/ISpecificOperator.php

51 lines
1.5 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 ISpecificOperator
*
* This interface represents an operator that is designed to work with exactly
* one entity type.
*
* In almost all of the cases it is not necessary to have this limitation,
* because the action is not connected to the event. This mechanism suits
* special cases.
*
* @package OCP\WorkflowEngine
* @since 18.0.0
*/
interface ISpecificOperator extends IOperator {
/**
* returns the id of the entity the operator is designed for
*
* Example: 'WorkflowEngine_Entity_File'
*
* @since 18.0.0
*/
public function getEntityId():string;
}