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
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package org.libreoffice.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>
*
*/
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.
* @throws java.io.IOException
* @throws ReportExecutionException
*/
void execute()
throws ReportExecutionException, IOException;
/**
* Interrupt the job.
*/
void interrupt();
/**
* Queries the jobs execution status.
*
* @return true, if the job is currently running, false otherwise.
*/
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.
*/
boolean isFinished();
void addProgressIndicator(JobProgressIndicator indicator);
void removeProgressIndicator(JobProgressIndicator indicator);
}
|
