1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ReportJob.java,v $
* $Revision: 1.4 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package com.sun.star.report;
import java.io.IOException;
/**
* This allows some simple job control. A job can be interrupted (or if it has
* not yet been started, canceled), and the job status can be queried (scheduled,
* running, finished).
*
* <table border="1">
* <tr>
* <th>JobStatus</th><th>running</th><th>finished</th>
* </tr>
* <tr>
* <td>Scheduled</td><td>false</td><td>false</td>
* </tr>
* <tr>
* <td>Running</td><td>true</td><td>false</td>
* </tr>
* <tr>
* <td>Finished</td><td>false</td><td>true</td>
* </tr>
* </table>
*
* @author Thomas Morgner
*/
public interface ReportJob
{
/**
* Although we might want to run the job as soon as it has been
* created, sometimes it is wiser to let the user add some listeners
* first. If we execute at once, the user either has to deal with
* threading code or wont receive any progress information in single
* threaded environments.
*/
public void execute()
throws ReportExecutionException, IOException;
/**
* Interrupt the job.
*/
public void interrupt();
/**
* Queries the jobs execution status.
*
* @return true, if the job is currently running, false otherwise.
*/
public boolean isRunning();
/**
* Queries the jobs result status.
*
* @return true, if the job is finished (or has been interrupted), false
* if the job waits for activation.
*/
public boolean isFinished();
public void addProgressIndicator(JobProgressIndicator indicator);
public void removeProgressIndicator(JobProgressIndicator indicator);
}
|