IComplexOperation.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  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 IComplexOperation
  27. *
  28. * This interface represents an operator that is less generic and indicates
  29. * that some of the tasks it does itself instead of relying on the engine.
  30. * This includes:
  31. *
  32. * * registering listeners – the implementing app needs to ensure that the
  33. * business logic registers listeners to the events it listens to. For example
  34. * when direct storage access is required, adding a wrapper or listening to
  35. * a specific one is required over usual file events.
  36. *
  37. *
  38. * @since 18.0.0
  39. */
  40. interface IComplexOperation extends IOperation {
  41. /**
  42. * As IComplexOperation chooses the triggering events itself, a hint has
  43. * to be shown to the user so make clear when this operation is becoming
  44. * active. This method returns such a translated string.
  45. *
  46. * Example: "When a file is accessed" (en)
  47. *
  48. * @since 18.0.0
  49. */
  50. public function getTriggerHint(): string;
  51. }