001/* MultiDocPrintJob.java -- 002 Copyright (C) 2004, 2006 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 038 039package javax.print; 040 041import javax.print.attribute.PrintRequestAttributeSet; 042 043 044/** 045 * <code>MultiDocPrintJob</code> represents a print job which supports 046 * printing of multiple documents as one print job. 047 * <p> 048 * An instance can be obtained from every <code>MultiDocPrintService</code> 049 * available by calling the 050 * {@link javax.print.MultiDocPrintService#createMultiDocPrintJob()} method. 051 * A print job is bound to the print service it is created from. 052 * </p> 053 * 054 * @author Michael Koch (konqueror@gmx.de) 055 */ 056public interface MultiDocPrintJob extends DocPrintJob 057{ 058 /** 059 * Prints the documents supplied in the given <code>MultiDoc</code> object 060 * as one print job with the given printing attributes. 061 * 062 * @param multiDoc the documents to print. Every document must have a 063 * flavor supported by the bound print service. 064 * @param attributes the printing attributes to apply to the print job. If 065 * <code>null</code> the default attribute values will be used. 066 * 067 * @throws PrintException if an error occurs. The thrown exception may 068 * implement refining print exception interface to provide more detail of 069 * the error. 070 * 071 * @see FlavorException 072 * @see AttributeException 073 */ 074 void print(MultiDoc multiDoc, PrintRequestAttributeSet attributes) 075 throws PrintException; 076}