Source for javax.print.MultiDocPrintJob

   1: /* MultiDocPrintJob.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: import javax.print.attribute.PrintRequestAttributeSet;
  42: 
  43: 
  44: /**
  45:  * <code>MultiDocPrintJob</code> represents a print job which supports 
  46:  * printing of multiple documents as one print job.
  47:  * <p>
  48:  * An instance can be obtained from every <code>MultiDocPrintService</code>
  49:  * available by calling the 
  50:  * {@link javax.print.MultiDocPrintService#createMultiDocPrintJob()} method. 
  51:  * A print job is bound to the print service it is created from.
  52:  * </p>
  53:  * 
  54:  * @author Michael Koch (konqueror@gmx.de)
  55:  */
  56: public interface MultiDocPrintJob extends DocPrintJob
  57: {
  58:   /**
  59:    * Prints the documents supplied in the given <code>MultiDoc</code> object 
  60:    * as one print job with the given printing attributes.
  61:    * 
  62:    * @param multiDoc the documents to print. Every document must have a 
  63:    * flavor supported by the bound print service.
  64:    * @param attributes the printing attributes to apply to the print job. If 
  65:    * <code>null</code> the default attribute values will be used.
  66:    * 
  67:    * @throws PrintException if an error occurs. The thrown exception may 
  68:    * implement refining print exception interface to provide more detail of 
  69:    * the error.
  70:    * 
  71:    * @see FlavorException
  72:    * @see AttributeException
  73:    */
  74:   void print(MultiDoc multiDoc, PrintRequestAttributeSet attributes)
  75:     throws PrintException;
  76: }