aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/WorkflowEngine/IEntityCheck.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/WorkflowEngine/IEntityCheck.php')
-rw-r--r--lib/public/WorkflowEngine/IEntityCheck.php33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/public/WorkflowEngine/IEntityCheck.php b/lib/public/WorkflowEngine/IEntityCheck.php
new file mode 100644
index 00000000000..ccfeb2ece0b
--- /dev/null
+++ b/lib/public/WorkflowEngine/IEntityCheck.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\WorkflowEngine;
+
+/**
+ * Interface IFileCheck
+ *
+ * @since 18.0.0
+ */
+interface IEntityCheck {
+ /**
+ * Equips the check with a subject fitting the Entity. For instance, an
+ * entity of File will receive an instance of OCP\Files\Node, or a comment
+ * entity might get an IComment.
+ *
+ * The implementing check must be aware of the incoming type.
+ *
+ * If an unsupported subject is passed the implementation MAY throw an
+ * \UnexpectedValueException.
+ *
+ * @param IEntity $entity
+ * @param mixed $subject
+ * @throws \UnexpectedValueException
+ * @since 18.0.0
+ */
+ public function setEntitySubject(IEntity $entity, $subject): void;
+}