1	<?php
2
3	/**
4	* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License
6	* as published by the Free Software Foundation; under version 2
7	* of the License (non-upgradable).
8	*
9	* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12	* GNU General Public License for more details.
13	*
14	* You should have received a copy of the GNU General Public License
15	* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17	*
18	* Copyright (c) 2017 (original work) Open Assessment Technologies SA;
19	*
20	*
21	*/
22
23	namespace oat\tao\model\actionQueue;
24
25	use oat\oatbox\action\Action as TaoAction;
26	use Zend\ServiceManager\ServiceLocatorAwareInterface;
27
28	/**
29	* Interface QueuedAction
30	*
31	* Action to be performed in action queue
32	*
33	* @author Aleh Hutnikau, <hutnikau@1pt.com>
34	* @package oat\tao\model\actionQueue
35	*/
36	interface QueuedAction extends TaoAction, ServiceLocatorAwareInterface
37	{
38	/**
39	* Get action identifier
40	* @return mixed
41	*/
42	public function getId();
43
44	/**
45	* Get number of actions in progress.
46	* Based on this value action queue will decide whether action should be performed or not.
47	* @return integer
48	*/
49	public function getNumberOfActiveActions();
50
51	/**
52	* Return result of action execution
53	* @return mixed
54	*/
55	public function getResult();
56
57	/**
58	* Set result of action
59	* @param mixed $result
60	*/
61	public function setResult($result);
62	}