|
JavaTM 2 Platform Std. Ed. v1.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.print.attribute.EnumSyntax | +--javax.print.attribute.standard.JobStateReason
Class JobStateReason is a printing attribute class, an enumeration, that
provides additional information about the job's current state, i.e.,
information that augments the value of the job's JobState
attribute. Class JobStateReason defines standard job state reason values. A
Print Service implementation only needs to report those job state
reasons which are appropriate for the particular implementation; it does not
have to report every defined job state reason.
Instances of JobStateReason do not appear in a Print Job's attribute set
directly. Rather, a JobStateReasons
attribute appears
in the Print Job's attribute set. The JobStateReasons
attribute contains zero, one, or more than one JobStateReason objects which
pertain to the Print Job's status. The printer adds a JobStateReason object
to the Print Job's JobStateReasons
attribute when the
corresponding condition becomes true of the Print Job, and the printer
removes the JobStateReason object again when the corresponding condition
becomes false, regardless of whether the Print Job's overall JobState
also changed.
IPP Compatibility: The category name returned by
getName()
is the IPP attribute name. The enumeration's
integer value is the IPP enum value. The toString()
method
returns the IPP string representation of the attribute value.
Field Summary | |
static JobStateReason |
ABORTED_BY_SYSTEM
The job was aborted by the system. |
static JobStateReason |
COMPRESSION_ERROR
The job was aborted by the system because the printer encountered an error in the document data while decompressing it. |
static JobStateReason |
DOCUMENT_ACCESS_ERROR
The Printer could not access one or more documents passed by reference (i.e., the print data representation object is a URL). |
static JobStateReason |
DOCUMENT_FORMAT_ERROR
The job was aborted by the system because the printer encountered an error in the document data while processing it. |
static JobStateReason |
JOB_CANCELED_AT_DEVICE
The job was canceled by an unidentified local user, i.e., a user at a console at the device. |
static JobStateReason |
JOB_CANCELED_BY_OPERATOR
The job was canceled by the operator, i.e., by a user who has been authenticated as having operator privileges (whether local or remote). |
static JobStateReason |
JOB_CANCELED_BY_USER
The job was canceled by the owner of the job, i.e., by a user whose authenticated identity is the same as the value of the originating user that created the Print Job, or by some other authorized end-user, such as a member of the job owner's security group. |
static JobStateReason |
JOB_COMPLETED_SUCCESSFULLY
The job completed successfully. |
static JobStateReason |
JOB_COMPLETED_WITH_ERRORS
The job completed with errors (and possibly warnings too). |
static JobStateReason |
JOB_COMPLETED_WITH_WARNINGS
The job completed with warnings. |
static JobStateReason |
JOB_DATA_INSUFFICIENT
The printer has created the Print Job, but the printer is expecting additional print data before it can move the job into the PROCESSING state. |
static JobStateReason |
JOB_HOLD_UNTIL_SPECIFIED
The value of the job's JobHoldUntil attribute was
specified with a date-time that is still in the future. |
static JobStateReason |
JOB_INCOMING
The printer has created the Print Job, but the printer has not finished accessing or accepting all the print data yet. |
static JobStateReason |
JOB_INTERPRETING
The job is in the PROCESSING state, but more specifically, the printer ia interpreting the document data. |
static JobStateReason |
JOB_OUTGOING
The printer is transmitting the job to the output device. |
static JobStateReason |
JOB_PRINTING
The output device is marking media. |
static JobStateReason |
JOB_QUEUED
The job is in the PROCESSING state, but more specifically, the printer has queued the document data. |
static JobStateReason |
JOB_QUEUED_FOR_MARKER
The job is in the PENDING_HELD, PENDING, or PROCESSING state, but more specifically, the printer has completed enough processing of the document to be able to start marking and the job is waiting for the marker. |
static JobStateReason |
JOB_RESTARTABLE
This job is retained and is currently able to be restarted. |
static JobStateReason |
JOB_TRANSFORMING
The job is in the PROCESSING state, but more specifically, the printer is interpreting document data and producing another electronic representation. |
static JobStateReason |
PRINTER_STOPPED
The value of the printer's PrinterState attribute
ia STOPPED. |
static JobStateReason |
PRINTER_STOPPED_PARTLY
The value of the printer's PrinterStateReasons attribute contains a PrinterStateReason value of STOPPED_PARTLY. |
static JobStateReason |
PROCESSING_TO_STOP_POINT
The requester has canceled the job or the printer has aborted the job, but the printer is still performing some actions on the job until a specified stop point occurs or job termination/cleanup is completed. |
static JobStateReason |
QUEUED_IN_DEVICE
The job has been forwarded to a device or print system that is unable to send back status. |
static JobStateReason |
RESOURCES_ARE_NOT_READY
At least one of the resources needed by the job, such as media, fonts, resource objects, etc., is not ready on any of the physical printers for which the job is a candidate. |
static JobStateReason |
SERVICE_OFF_LINE
The printer is off-line and accepting no jobs. |
static JobStateReason |
SUBMISSION_INTERRUPTED
The job was not completely submitted for some unforeseen reason. |
static JobStateReason |
UNSUPPORTED_COMPRESSION
The job was aborted by the system because the printer determined while attempting to decompress the document's data that the compression is actually not among those supported by the printer. |
static JobStateReason |
UNSUPPORTED_DOCUMENT_FORMAT
The job was aborted by the system because the document data's document format (doc flavor) is not among those supported by the printer. |
Constructor Summary | |
protected |
JobStateReason(int value)
Construct a new job state reason enumeration value with the given integer value. |
Method Summary | |
Class |
getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
protected EnumSyntax[] |
getEnumValueTable()
Returns the enumeration value table for class JobStateReason. |
String |
getName()
Get the name of the category of which this attribute value is an instance. |
protected String[] |
getStringTable()
Returns the string table for class JobStateReason. |
Methods inherited from class javax.print.attribute.EnumSyntax |
clone, getOffset, getValue, hashCode, readResolve, toString |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final JobStateReason JOB_INCOMING
public static final JobStateReason JOB_DATA_INSUFFICIENT
public static final JobStateReason DOCUMENT_ACCESS_ERROR
JobStateReasons
attribute depends on
implementation and/or site policy. This value should be supported if
the printer supports doc flavors with URL print data representation
objects.
public static final JobStateReason SUBMISSION_INTERRUPTED
public static final JobStateReason JOB_OUTGOING
public static final JobStateReason JOB_HOLD_UNTIL_SPECIFIED
JobHoldUntil
attribute was
specified with a date-time that is still in the future. The job must
not be a candidate for processing until this reason is removed and
there are
no other reasons to hold the job. This value should be supported if the
JobHoldUntil
job template attribute is supported.
public static final JobStateReason RESOURCES_ARE_NOT_READY
public static final JobStateReason PRINTER_STOPPED_PARTLY
PrinterStateReasons
attribute contains a PrinterStateReason
value of STOPPED_PARTLY.
public static final JobStateReason PRINTER_STOPPED
PrinterState
attribute
ia STOPPED.
public static final JobStateReason JOB_INTERPRETING
public static final JobStateReason JOB_QUEUED
public static final JobStateReason JOB_TRANSFORMING
public static final JobStateReason JOB_QUEUED_FOR_MARKER
public static final JobStateReason JOB_PRINTING
public static final JobStateReason JOB_CANCELED_BY_USER
public static final JobStateReason JOB_CANCELED_BY_OPERATOR
public static final JobStateReason JOB_CANCELED_AT_DEVICE
public static final JobStateReason ABORTED_BY_SYSTEM
public static final JobStateReason UNSUPPORTED_COMPRESSION
Compression
is a required doc
description attribute.
public static final JobStateReason COMPRESSION_ERROR
public static final JobStateReason UNSUPPORTED_DOCUMENT_FORMAT
"application/octet-stream"
, the printer may abort the job if
the printer cannot determine the document data's actual format through
auto-sensing (even if the printer supports the document format if
specified explicitly). This value must be supported, since a doc flavor
is required to be specified for each doc.
public static final JobStateReason DOCUMENT_FORMAT_ERROR
public static final JobStateReason PROCESSING_TO_STOP_POINT
If the implementation requires some measurable time to cancel the job in the PROCESSING or PROCESSING_STOPPED job states, the printer must use this reason to indicate that the printer is still performing some actions on the job while the job remains in the PROCESSING or PROCESSING_STOPPED state. After all the job's job description attributes have stopped incrementing, the printer moves the job from the PROCESSING state to the CANCELED or ABORTED job states.
public static final JobStateReason SERVICE_OFF_LINE
public static final JobStateReason JOB_COMPLETED_SUCCESSFULLY
public static final JobStateReason JOB_COMPLETED_WITH_WARNINGS
public static final JobStateReason JOB_COMPLETED_WITH_ERRORS
public static final JobStateReason JOB_RESTARTABLE
JobStateReasons
attribute, then the printer must accept a request to
restart that job. This value should be supported if restarting jobs is
supported. [The capability for restarting jobs is not in the Java
Print Service API at present.]
public static final JobStateReason QUEUED_IN_DEVICE
JobState
attribute to COMPLETED and adds the QUEUED_IN_DEVICE reason to the job's
JobStateReasons
attribute to indicate that the
printer has no additional information about the job and never will have
any better information.
Constructor Detail |
protected JobStateReason(int value)
value
- Integer value.Method Detail |
protected String[] getStringTable()
getStringTable
in class EnumSyntax
protected EnumSyntax[] getEnumValueTable()
getEnumValueTable
in class EnumSyntax
public final Class getCategory()
For class JobStateReason and any vendor-defined subclasses, the category is class JobStateReason itself.
getCategory
in interface Attribute
java.lang.Class
.public final String getName()
For class JobStateReason and any vendor-defined subclasses, the
category name is "job-state-reason"
.
getName
in interface Attribute
|
JavaTM 2 Platform Std. Ed. v1.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.