01 /*
02 * Copyright 2000-2001 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.print.event;
27
28 /**
29 * Implementations of this listener interface should be attached to a
30 * {@link javax.print.DocPrintJob DocPrintJob} to monitor the status of
31 * the printer job.
32 * These callback methods may be invoked on the thread processing the
33 * print job, or a service created notification thread. In either case
34 * the client should not perform lengthy processing in these callbacks.
35 */
36
37 public interface PrintJobListener {
38
39 /**
40 * Called to notify the client that data has been successfully
41 * transferred to the print service, and the client may free
42 * local resources allocated for that data. The client should
43 * not assume that the data has been completely printed after
44 * receiving this event.
45 * If this event is not received the client should wait for a terminal
46 * event (completed/canceled/failed) before freeing the resources.
47 * @param pje the job generating this event
48 */
49 public void printDataTransferCompleted(PrintJobEvent pje);
50
51 /**
52 * Called to notify the client that the job completed successfully.
53 * @param pje the job generating this event
54 */
55 public void printJobCompleted(PrintJobEvent pje);
56
57 /**
58 * Called to notify the client that the job failed to complete
59 * successfully and will have to be resubmitted.
60 * @param pje the job generating this event
61 */
62 public void printJobFailed(PrintJobEvent pje);
63
64 /**
65 * Called to notify the client that the job was canceled
66 * by a user or a program.
67 * @param pje the job generating this event
68 */
69 public void printJobCanceled(PrintJobEvent pje);
70
71 /**
72 * Called to notify the client that no more events will be delivered.
73 * One cause of this event being generated is if the job
74 * has successfully completed, but the printing system
75 * is limited in capability and cannot verify this.
76 * This event is required to be delivered if none of the other
77 * terminal events (completed/failed/canceled) are delivered.
78 * @param pje the job generating this event
79 */
80 public void printJobNoMoreEvents(PrintJobEvent pje);
81
82 /**
83 * Called to notify the client that an error has occurred that the
84 * user might be able to fix. One example of an error that can
85 * generate this event is when the printer runs out of paper.
86 * @param pje the job generating this event
87 */
88 public void printJobRequiresAttention(PrintJobEvent pje);
89
90 }
|