001 /* DocPrintJob.java --
002 Copyright (C) 2004, 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.print;
040
041 import javax.print.attribute.PrintJobAttributeSet;
042 import javax.print.attribute.PrintRequestAttributeSet;
043 import javax.print.event.PrintJobAttributeListener;
044 import javax.print.event.PrintJobListener;
045
046 /**
047 * <code>DocPrintJob</code> represents a print job which supports printing
048 * of a single document.
049 * <p>
050 * An instance can be obtained from every <code>PrintService</code> available
051 * by calling the {@link javax.print.PrintService#createPrintJob()} method.
052 * A print job is bound to the print service it is created from.
053 * </p>
054 *
055 * @author Michael Koch (konqueror@gmx.de)
056 */
057 public interface DocPrintJob
058 {
059 /**
060 * Registers a listener for changes in the specified attribute set
061 * during processing of this print job.
062 * <p>
063 * If the given attribute set is empty no changes will be reported.
064 * If the set is <code>null</code> all attributes are monitored.
065 * </p>
066 *
067 * @param listener the listener to register.
068 * @param attributes the attributes to observe.
069 *
070 * @see #removePrintJobAttributeListener(PrintJobAttributeListener)
071 */
072 void addPrintJobAttributeListener(PrintJobAttributeListener listener,
073 PrintJobAttributeSet attributes);
074
075 /**
076 * Registers a listener for events occuring during processing
077 * of this print job.
078 *
079 * @param listener the listener to add, if <code>null</code> nothing is done.
080 *
081 * @see #removePrintJobListener(PrintJobListener)
082 */
083 void addPrintJobListener(PrintJobListener listener);
084
085 /**
086 * Returns the print job's attributes.
087 * <p>
088 * The returned set of attributes is a snapshot at the time of calling this
089 * method and will not be updated if changes to the print job's attributes
090 * happens. To monitor changes register a print job listener.
091 * </p>
092 *
093 * @return The attributes of this print job,
094 * may be empty but never <code>null</code>.
095 */
096 PrintJobAttributeSet getAttributes();
097
098 /**
099 * Returns the <code>PrintService</code> object this print job is bound to.
100 *
101 * @return The print service.
102 */
103 PrintService getPrintService();
104
105 /**
106 * Prints a document with the specified print job attributes.
107 *
108 * <p>
109 * If the doc flavor provided by the <code>Doc</code> implementation is
110 * not supported by this print service a <code>PrintException</code>
111 * implementing the <code>FlavorException</code> interface will be thrown.
112 * </p>
113 *
114 * @param doc the document to print
115 * @param attributes the job attributes to use. If <code>null</code> the
116 * default attribute values of the print service will be used.
117 *
118 * @throws PrintException if an error occurs. The thrown exception may
119 * implement refining print exception interface to provide more detail of
120 * the error.
121 *
122 * @see AttributeException
123 * @see FlavorException
124 */
125 void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException;
126
127 /**
128 * Removes the given listener from the listeners registered for changes
129 * in their provided attribute set during processing of this print job.
130 *
131 * @param listener the listener to remove, if <code>null</code> or not
132 * registered nothing will be done.
133 *
134 * @see #addPrintJobAttributeListener(PrintJobAttributeListener, PrintJobAttributeSet)
135 */
136 void removePrintJobAttributeListener(PrintJobAttributeListener listener);
137
138 /**
139 * Removes the given listener from the listeners registered for events
140 * occuring during processing of this print job.
141 *
142 * @param listener the listener to remove, if <code>null</code> or not
143 * registered nothing will be done.
144 *
145 * @see #addPrintJobListener(PrintJobListener)
146 */
147 void removePrintJobListener(PrintJobListener listener);
148 }