Statistics
| Revision:

svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.compat.cdc / org.gvsig.remoteclient / src / main / java / org / gvsig / remoteclient / taskplanning / IRunnableTask.java @ 40769

History | View | Annotate | Download (1.8 KB)

1
/**
2
 * gvSIG. Desktop Geographic Information System.
3
 *
4
 * Copyright (C) 2007-2013 gvSIG Association.
5
 *
6
 * This program is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU General Public License
8
 * as published by the Free Software Foundation; either version 3
9
 * of the License, or (at your option) any later version.
10
 *
11
 * This program is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 * GNU General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU General Public License
17
 * along with this program; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19
 * MA  02110-1301, USA.
20
 *
21
 * For any additional information, do not hesitate to contact us
22
 * at info AT gvsig.com, or visit our website www.gvsig.com.
23
 */
24
package org.gvsig.remoteclient.taskplanning;
25

    
26
/**
27
 * Interface implemented by those tasks that can be background-executed,
28
 * cancelled or any other thing.
29
 * 
30
 * @author jaume dominguez faus - jaume.dominguez@iver.es
31
 */
32
public interface IRunnableTask {
33
        /**
34
         * Executes this task's operations.
35
         */
36
        public void execute();
37
        
38
        /**
39
         * Cancels the current execution, if any, of this task. Should have no
40
         * effect if the task is not executing anything.
41
         */
42
        public void cancel();
43
        
44
        /**
45
         * Tells if the task is on execution.
46
         * @return true if the task is busy, false otherwise.
47
         */
48
        public boolean isRunning();
49
        
50
        /**
51
         * Returns the timeout set to this task in milliseconds
52
         * @return the amount of milliseconds to wait until the task
53
         *                    will be considered as unsuccessful, or 0 or less to
54
         *                    say that task can wait forever.
55
         */
56
        public long getTaskTimeout();
57
}