Source for javax.print.CancelablePrintJob

   1: /* CancelablePrintJob.java --
   2:    Copyright (C) 2004, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.print;
  40: 
  41: /**
  42:  * <code>CancelablePrintJob</code> represents a print job which can be 
  43:  * canceled.
  44:  * <p>
  45:  * It is implemented by <code>DocPrintJob</code>s which support to cancel 
  46:  * a print job during processing. Clients need to explicitly test if a given 
  47:  * <code>DocPrintJob</code> object from a print service implementes this 
  48:  * interface and therefore supports cancelling.
  49:  * </p><p>
  50:  * Implementor of java print services should implement this interface if
  51:  * cancelling is supported by the underlying print system. If implemented the
  52:  * corresponding print job event 
  53:  * {@link javax.print.event.PrintJobEvent#JOB_CANCELED} should be delivered to 
  54:  * registered clients. Implementations have to be thread-safe.
  55:  * </p>
  56:  *
  57:  * @author Michael Koch (konqueror@gmx.de)
  58:  */
  59: public interface CancelablePrintJob extends DocPrintJob
  60: {
  61:   /**
  62:    * Cancel the print job.
  63:    *
  64:    * @exception PrintException if an error during cancellation occurs.
  65:    */
  66:   void cancel() throws PrintException;
  67: }