1
0

IComplexOperation.php 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  5. * SPDX-License-Identifier: AGPL-3.0-or-later
  6. */
  7. namespace OCP\WorkflowEngine;
  8. /**
  9. * Interface IComplexOperation
  10. *
  11. * This interface represents an operator that is less generic and indicates
  12. * that some of the tasks it does itself instead of relying on the engine.
  13. * This includes:
  14. *
  15. * * registering listeners – the implementing app needs to ensure that the
  16. * business logic registers listeners to the events it listens to. For example
  17. * when direct storage access is required, adding a wrapper or listening to
  18. * a specific one is required over usual file events.
  19. *
  20. *
  21. * @since 18.0.0
  22. */
  23. interface IComplexOperation extends IOperation {
  24. /**
  25. * As IComplexOperation chooses the triggering events itself, a hint has
  26. * to be shown to the user so make clear when this operation is becoming
  27. * active. This method returns such a translated string.
  28. *
  29. * Example: "When a file is accessed" (en)
  30. *
  31. * @since 18.0.0
  32. */
  33. public function getTriggerHint(): string;
  34. }