07260579b6c1726ab114e582edb56ca95b1c81b7
[core.git] / framework / main / interfaces / tasks / class_Taskable.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Task;
4
5 // Import framework stuff
6 use CoreFramework\Generic\FrameworkInterface;
7
8 /**
9  * An interface for tasks
10  *
11  * @author              Roland Haeder <webmaster@shipsimu.org>
12  * @version             0.0.0
13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.org
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
29  */
30 interface Taskable extends FrameworkInterface {
31         /**
32          * Accepts the visitor to process the visitor
33          *
34          * @param       $visitorInstance        An instance of a Visitor class
35          * @return      void
36          */
37         function accept (Visitor $visitorInstance);
38
39         /**
40          * Executes the task
41          *
42          * @return      void
43          */
44         function executeTask ();
45
46         /**
47          * Shuts down the task
48          *
49          * @return      void
50          */
51         function doShutdown ();
52
53 }