Commit | Line | Data |
---|---|---|
11ade432 | 1 | <?php |
a9229942 | 2 | |
11ade432 AE |
3 | namespace wcf\data; |
4 | ||
5 | /** | |
6 | * Default interface for DatabaseObject-related actions. | |
a9229942 TD |
7 | * |
8 | * @author Marcel Werk | |
9 | * @copyright 2001-2019 WoltLab GmbH | |
10 | * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php> | |
11ade432 | 11 | */ |
a9229942 TD |
12 | interface IDatabaseObjectAction |
13 | { | |
14 | /** | |
15 | * Executes the previously chosen action. | |
16 | */ | |
17 | public function executeAction(); | |
18 | ||
19 | /** | |
20 | * Validates action-related parameters. | |
21 | */ | |
22 | public function validateAction(); | |
23 | ||
24 | /** | |
25 | * Returns active action name. | |
26 | * | |
27 | * @return string | |
28 | */ | |
29 | public function getActionName(); | |
30 | ||
31 | /** | |
32 | * Returns DatabaseObject-related object ids. | |
33 | * | |
34 | * @return int[] | |
35 | */ | |
36 | public function getObjectIDs(); | |
37 | ||
38 | /** | |
39 | * Returns action-related parameters. | |
40 | * | |
41 | * @return mixed[] | |
42 | */ | |
43 | public function getParameters(); | |
44 | ||
45 | /** | |
46 | * Returns results returned by active action. | |
47 | * | |
48 | * @return mixed | |
49 | */ | |
50 | public function getReturnValues(); | |
11ade432 | 51 | } |