reportbuilder/java/org/libreoffice/report/ReportJob.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package org.libreoffice.report;
  19
  20 import java.io.IOException;
  21
  22 /**
  23  * This allows some simple job control. A job can be interrupted (or if it has
  24  * not yet been started, canceled), and the job status can be queried (scheduled,
  25  * running, finished).
  26  *
  27  * <table summary="Job status values" border="1">
  28  * <tr>
  29  * <th>JobStatus</th><th>running</th><th>finished</th>
  30  * </tr>
  31  * <tr>
  32  * <td>Scheduled</td><td>false</td><td>false</td>
  33  * </tr>
  34  * <tr>
  35  * <td>Running</td><td>true</td><td>false</td>
  36  * </tr>
  37  * <tr>
  38  * <td>Finished</td><td>false</td><td>true</td>
  39  * </tr>
  40  * </table>
  41  *
  42  */
  43 public interface ReportJob
  44 {
  45
  46     /**
  47      * Although we might want to run the job as soon as it has been
  48      * created, sometimes it is wiser to let the user add some listeners
  49      * first. If we execute at once, the user either has to deal with
  50      * threading code or won't receive any progress information in single
  51      * threaded environments.
  52      * @throws java.io.IOException
  53      * @throws ReportExecutionException
  54      */
  55     void execute()
  56             throws ReportExecutionException, IOException;
  57
  58 }