blob: 06a5d1680b0ea48ae11925a0db315161d14c8044 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\WorkflowEngine;
use RuntimeException;
/**
* Class IRuleMatcher
*
*
* @since 18.0.0
*/
interface IRuleMatcher extends IFileCheck {
/**
* This method is left for backwards compatibility and easier porting of
* apps. Please use 'getFlows' instead (and setOperation if you implement
* an IComplexOperation).
*
* @since 18.0.0
* @deprecated 18.0.0
*/
public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array;
/**
* @throws RuntimeException
* @since 18.0.0
*/
public function getFlows(bool $returnFirstMatchingOperationOnly = true): array;
/**
* this method can only be called once and is typically called by the
* Flow engine, unless for IComplexOperations.
*
* @throws RuntimeException
* @since 18.0.0
*/
public function setOperation(IOperation $operation): void;
/**
* this method can only be called once and is typically called by the
* Flow engine, unless for IComplexOperations.
*
* @throws RuntimeException
* @since 18.0.0
*/
public function setEntity(IEntity $entity): void;
/**
* returns the entity which might provide more information, depending on
* the interfaces it implements
*
* @return IEntity
* @since 18.0.0
*/
public function getEntity(): IEntity;
/**
* this method can be called once to set the event name that is currently
* being processed. The workflow engine takes care of this usually, only an
* IComplexOperation might want to make use of it.
*
* @throws RuntimeException
* @since 20.0.0
*/
public function setEventName(string $eventName): void;
}
|
