aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/WorkflowEngine/IOperator.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/WorkflowEngine/IOperator.php')
-rw-r--r--lib/public/WorkflowEngine/IOperator.php91
1 files changed, 0 insertions, 91 deletions
diff --git a/lib/public/WorkflowEngine/IOperator.php b/lib/public/WorkflowEngine/IOperator.php
deleted file mode 100644
index 70c80d98c45..00000000000
--- a/lib/public/WorkflowEngine/IOperator.php
+++ /dev/null
@@ -1,91 +0,0 @@
-<?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;
-
-/**
- * @since 18.0.0
- */
-interface IOperator {
- /**
- * returns the unique identity of the operator
- *
- * It is recommended to use the namespaced class name of the IOperator
- * implementation. Especially workflow applications released before
- * Nextcloud 18 should chose this as id for compatibility.
- *
- * Example: OCA\FilesAutomatedTagging\Operation
- *
- * @since 18.0.0
- */
- public function getId(): string;
-
- /**
- * returns a translated name to be presented in the web interface
- *
- * Example: "Automated tagging" (en), "AĆ­tomata etikedado" (eo)
- *
- * @since 18.0.0
- */
- public function getDisplayName(): string;
-
- /**
- * returns a translated, descriptive text to be presented in the web interface.
- *
- * It should be short and precise.
- *
- * Example: "Tag based automatic deletion of files after a given time." (en)
- *
- * @since 18.0.0
- */
- public function getDescription(): string;
-
- /**
- * returns the URL to the icon of the operator for display in the web interface.
- *
- * Usually, the implementation would utilize the `imagePath()` method of the
- * `\OCP\IURLGenerator` instance and simply return its result.
- *
- * Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg');
- *
- * @since 18.0.0
- */
- public function getIcon(): string;
-
- /**
- * returns whether the operation can be used in the requested scope.
- *
- * Scope IDs are defined as constants in OCP\WorkflowEngine\IManager. At
- * time of writing these are SCOPE_ADMIN and SCOPE_USER.
- *
- * For possibly unknown future scopes the recommended behaviour is: if
- * user scope is permitted, the default behaviour should return `true`,
- * otherwise `false`.
- *
- * @since 18.0.0
- */
- public function isAvailableForScope(int $scope): bool;
-
-
-}