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