1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski package com.sun.star.report; 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski import java.io.IOException; 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski /** 28*b1cdbd2cSJim Jagielski * This allows some simple job control. A job can be interrupted (or if it has 29*b1cdbd2cSJim Jagielski * not yet been started, canceled), and the job status can be queried (scheduled, 30*b1cdbd2cSJim Jagielski * running, finished). 31*b1cdbd2cSJim Jagielski * 32*b1cdbd2cSJim Jagielski * <table border="1"> 33*b1cdbd2cSJim Jagielski * <tr> 34*b1cdbd2cSJim Jagielski * <th>JobStatus</th><th>running</th><th>finished</th> 35*b1cdbd2cSJim Jagielski * </tr> 36*b1cdbd2cSJim Jagielski * <tr> 37*b1cdbd2cSJim Jagielski * <td>Scheduled</td><td>false</td><td>false</td> 38*b1cdbd2cSJim Jagielski * </tr> 39*b1cdbd2cSJim Jagielski * <tr> 40*b1cdbd2cSJim Jagielski * <td>Running</td><td>true</td><td>false</td> 41*b1cdbd2cSJim Jagielski * </tr> 42*b1cdbd2cSJim Jagielski * <tr> 43*b1cdbd2cSJim Jagielski * <td>Finished</td><td>false</td><td>true</td> 44*b1cdbd2cSJim Jagielski * </tr> 45*b1cdbd2cSJim Jagielski * </table> 46*b1cdbd2cSJim Jagielski * 47*b1cdbd2cSJim Jagielski * @author Thomas Morgner 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielski public interface ReportJob 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** 53*b1cdbd2cSJim Jagielski * Although we might want to run the job as soon as it has been 54*b1cdbd2cSJim Jagielski * created, sometimes it is wiser to let the user add some listeners 55*b1cdbd2cSJim Jagielski * first. If we execute at once, the user either has to deal with 56*b1cdbd2cSJim Jagielski * threading code or wont receive any progress information in single 57*b1cdbd2cSJim Jagielski * threaded environments. 58*b1cdbd2cSJim Jagielski * @throws java.io.IOException 59*b1cdbd2cSJim Jagielski * @throws ReportExecutionException 60*b1cdbd2cSJim Jagielski */ execute()61*b1cdbd2cSJim Jagielski void execute() 62*b1cdbd2cSJim Jagielski throws ReportExecutionException, IOException; 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** 65*b1cdbd2cSJim Jagielski * Interrupt the job. 66*b1cdbd2cSJim Jagielski */ interrupt()67*b1cdbd2cSJim Jagielski void interrupt(); 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** 70*b1cdbd2cSJim Jagielski * Queries the jobs execution status. 71*b1cdbd2cSJim Jagielski * 72*b1cdbd2cSJim Jagielski * @return true, if the job is currently running, false otherwise. 73*b1cdbd2cSJim Jagielski */ isRunning()74*b1cdbd2cSJim Jagielski boolean isRunning(); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** 77*b1cdbd2cSJim Jagielski * Queries the jobs result status. 78*b1cdbd2cSJim Jagielski * 79*b1cdbd2cSJim Jagielski * @return true, if the job is finished (or has been interrupted), false 80*b1cdbd2cSJim Jagielski * if the job waits for activation. 81*b1cdbd2cSJim Jagielski */ isFinished()82*b1cdbd2cSJim Jagielski boolean isFinished(); 83*b1cdbd2cSJim Jagielski addProgressIndicator(JobProgressIndicator indicator)84*b1cdbd2cSJim Jagielski void addProgressIndicator(JobProgressIndicator indicator); 85*b1cdbd2cSJim Jagielski removeProgressIndicator(JobProgressIndicator indicator)86*b1cdbd2cSJim Jagielski void removeProgressIndicator(JobProgressIndicator indicator); 87*b1cdbd2cSJim Jagielski } 88