ISpecificOperation.php 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\WorkflowEngine;
  25. /**
  26. * Interface ISpecificOperation
  27. *
  28. * This interface represents an operator that is designed to work with exactly
  29. * one entity type.
  30. *
  31. * In almost all of the cases it is not necessary to have this limitation,
  32. * because the action is not connected to the event. This mechanism suits
  33. * special cases.
  34. *
  35. * @since 18.0.0
  36. */
  37. interface ISpecificOperation extends IOperation {
  38. /**
  39. * returns the id of the entity the operator is designed for
  40. *
  41. * Example: 'WorkflowEngine_Entity_File'
  42. *
  43. * @since 18.0.0
  44. */
  45. public function getEntityId():string;
  46. }