/* PrintJobListener.java --
   Copyright (C) 2004, 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.print.event;


/**
 * Listener interface to receive processing events from a print job.
 * Implementations of this interface can be registered with a
 * {@link javax.print.DocPrintJob} instance.
 *
 * @see javax.print.event.PrintJobAdapter
 *
 * @author Michael Koch (konqueror@gmx.de)
 */
public interface PrintJobListener
{
  /**
   * Notifies the listener that all data has been successfully transferred
   * to the print service.
   *
   * @param event the event
   */
  void printDataTransferCompleted(PrintJobEvent event);

  /**
   * Notifies the listener that a print job got canceled.
   *
   * @param event the event
   */
  void printJobCanceled(PrintJobEvent event);

  /**
   * Notifies the listener that a print job has completed.
   *
   * @param event the event
   */
  void printJobCompleted(PrintJobEvent event);

  /**
   * Notifies the listener that a print job has failed to complete.
   *
   * @param event the event.
   */
  void printJobFailed(PrintJobEvent event);

  /**
   * Notifies the listener that no more events will be delivered.
   *
   * @param event the event
   */
  void printJobNoMoreEvents(PrintJobEvent event);

  /**
   * Notifies the listener that a problem occured during printing.
   * This event signals problems a user might be able to fix
   * (e.g. out of paper or paper jam).
   *
   * @param event the event
   */
  void printJobRequiresAttention(PrintJobEvent event);
}
