You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

73 lines
2.2 KiB

3 years ago
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Morris Jobke <hey@morrisjobke.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. * @author Roeland Jago Douma <roeland@famdouma.nl>
  9. *
  10. * @license GNU AGPL version 3 or any later version
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License as
  14. * published by the Free Software Foundation, either version 3 of the
  15. * License, or (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU Affero General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU Affero General Public License
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. *
  25. */
  26. namespace OCP\WorkflowEngine;
  27. /**
  28. * Interface IManager
  29. *
  30. * @since 9.1
  31. */
  32. interface IManager {
  33. public const SCOPE_ADMIN = 0;
  34. public const SCOPE_USER = 1;
  35. /**
  36. * @depreacted Will be removed in NC19. Use the dedicated events in OCP\WorkflowEngine\Events
  37. */
  38. public const EVENT_NAME_REG_OPERATION = 'OCP\WorkflowEngine::registerOperations';
  39. public const EVENT_NAME_REG_ENTITY = 'OCP\WorkflowEngine::registerEntities';
  40. public const EVENT_NAME_REG_CHECK = 'OCP\WorkflowEngine::registerChecks';
  41. /**
  42. * Listen to `OCP\WorkflowEngine\Events\RegisterEntitiesEvent` at the
  43. * IEventDispatcher for registering your entities.
  44. *
  45. * @since 18.0.0
  46. */
  47. public function registerEntity(IEntity $entity): void;
  48. /**
  49. * Listen to `OCP\WorkflowEngine\Events\RegisterOperationsEvent` at the
  50. * IEventDispatcher for registering your operators.
  51. *
  52. * @since 18.0.0
  53. */
  54. public function registerOperation(IOperation $operator): void;
  55. /**
  56. * Listen to `OCP\WorkflowEngine\Events\RegisterChecksEvent` at the
  57. * IEventDispatcher for registering your operators.
  58. *
  59. * @since 18.0.0
  60. */
  61. public function registerCheck(ICheck $check): void;
  62. /**
  63. * @since 18.0.0
  64. */
  65. public function getRuleMatcher(): IRuleMatcher;
  66. }