aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/WorkflowEngine/IManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/WorkflowEngine/IManager.php')
-rw-r--r--lib/public/WorkflowEngine/IManager.php63
1 files changed, 63 insertions, 0 deletions
diff --git a/lib/public/WorkflowEngine/IManager.php b/lib/public/WorkflowEngine/IManager.php
new file mode 100644
index 00000000000..f66a9460f06
--- /dev/null
+++ b/lib/public/WorkflowEngine/IManager.php
@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\WorkflowEngine;
+
+/**
+ * Interface IManager
+ *
+ * @since 9.1
+ */
+interface IManager {
+ /**
+ * @since 18.0.0
+ */
+ public const SCOPE_ADMIN = 0;
+
+ /**
+ * @since 18.0.0
+ */
+ public const SCOPE_USER = 1;
+
+ /**
+ * @since 21.0.0
+ */
+ public const MAX_CHECK_VALUE_BYTES = 2048;
+
+ /**
+ * @since 21.0.0
+ */
+ public const MAX_OPERATION_VALUE_BYTES = 4096;
+
+ /**
+ * Listen to `OCP\WorkflowEngine\Events\RegisterEntitiesEvent` at the
+ * IEventDispatcher for registering your entities.
+ *
+ * @since 18.0.0
+ */
+ public function registerEntity(IEntity $entity): void;
+
+ /**
+ * Listen to `OCP\WorkflowEngine\Events\RegisterOperationsEvent` at the
+ * IEventDispatcher for registering your operators.
+ *
+ * @since 18.0.0
+ */
+ public function registerOperation(IOperation $operator): void;
+
+ /**
+ * Listen to `OCP\WorkflowEngine\Events\RegisterChecksEvent` at the
+ * IEventDispatcher for registering your operators.
+ *
+ * @since 18.0.0
+ */
+ public function registerCheck(ICheck $check): void;
+
+ /**
+ * @since 18.0.0
+ */
+ public function getRuleMatcher(): IRuleMatcher;
+}