001/* PrintJobListener.java -- 
002   Copyright (C) 2004, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.print.event;
039
040
041/**
042 * Listener interface to receive processing events from a print job.
043 * Implementations of this interface can be registered with a 
044 * {@link javax.print.DocPrintJob} instance.
045 * 
046 * @see javax.print.event.PrintJobAdapter
047 *  
048 * @author Michael Koch (konqueror@gmx.de) 
049 */
050public interface PrintJobListener
051{
052  /**
053   * Notifies the listener that all data has been successfully transferred
054   * to the print service.
055   * 
056   * @param event the event
057   */
058  void printDataTransferCompleted(PrintJobEvent event);
059  
060  /**
061   * Notifies the listener that a print job got canceled.
062   * 
063   * @param event the event
064   */
065  void printJobCanceled(PrintJobEvent event);
066  
067  /**
068   * Notifies the listener that a print job has completed.
069   * 
070   * @param event the event
071   */
072  void printJobCompleted(PrintJobEvent event);
073  
074  /**
075   * Notifies the listener that a print job has failed to complete.
076   * 
077   * @param event the event.
078   */
079  void printJobFailed(PrintJobEvent event);
080  
081  /**
082   * Notifies the listener that no more events will be delivered.
083   * 
084   * @param event the event
085   */
086  void printJobNoMoreEvents(PrintJobEvent event);
087  
088  /**
089   * Notifies the listener that a problem occured during printing.
090   * This event signals problems a user might be able to fix 
091   * (e.g. out of paper or paper jam).
092   * 
093   * @param event the event
094   */
095  void printJobRequiresAttention(PrintJobEvent event);
096}