1 /*
   2  * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.print;
  27 
  28 import javax.print.attribute.PrintRequestAttributeSet;
  29 
  30 /**
  31  *
  32  * Obtained from a MultiDocPrintService, a MultiDocPrintJob can print a
  33  * specified collection of documents as a single print job with a set of
  34  * job attributes.
  35  */
  36 
  37 public interface MultiDocPrintJob extends DocPrintJob {
  38 
  39    /**
  40      * Print a MultiDoc with the specified job attributes.
  41      * This method should only be called once for a given print job.
  42      * Calling it again will not result in a new job being spooled to
  43      * the printer. The service implementation will define policy
  44      * for service interruption and recovery. Application clients which
  45      * want to monitor the success or failure should register a
  46      * PrintJobListener.
  47      *
  48      * @param multiDoc The documents to be printed. ALL must be a flavor
  49      *        supported by the PrintJob {@literal &} PrintService.
  50      *
  51      * @param attributes The job attributes to be applied to this print job.
  52      *        If this parameter is null then the default attributes are used.
  53      *
  54      * @throws PrintException The exception additionally may implement
  55      * an interfaces which more precisely describes the cause of the exception
  56      * <ul>
  57      * <li>FlavorException.
  58      *  If the document has a flavor not supported by this print job.
  59      * <li>AttributeException.
  60      *  If one or more of the attributes are not valid for this print job.
  61      * </ul>
  62      */
  63     public void print(MultiDoc multiDoc, PrintRequestAttributeSet attributes)
  64                 throws PrintException;
  65 
  66 }