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) 2015 (original work) Open Assessment Technologies SA;
19	*
20	*
21	*/
22
23	namespace oat\tao\model\requiredAction;
24
25	use oat\oatbox\PhpSerializable;
26
27	/**
28	* Interface RequiredActionInterface
29	*
30	* RequiredAction is action which should be executed by user before performing any activities in the TAO
31	*
32	* @package oat\tao\model\requiredAction
33	* @author Aleh Hutnilau <hutnikau@1pt.com>
34	*/
35	interface RequiredActionInterface extends PhpSerializable
36	{
37	/**
38	* @return string
39	*/
40	public function getName();
41
42	/**
43	* @param RequiredActionRuleInterface $rule
44	* @return mixed
45	*/
46	public function setRule(RequiredActionRuleInterface $rule);
47
48	/**
49	* @return RequiredActionRuleInterface[]
50	*/
51	public function getRules();
52
53	/**
54	* Execute an action.
55	* @return mixed
56	*/
57	public function execute();
58
59	/**
60	* Mark action as completed.
61	* @return mixed
62	*/
63	public function completed();
64
65	/**
66	* Check whether the action must be executed.
67	* @return boolean
68	*/
69	public function mustBeExecuted();
70	}