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.
| Modifier and Type | Field and Description |
|---|---|
| public static final JobStateReason | ABORTED_BY_SYSTEM
The job was aborted by the system. |
| public static final JobStateReason | COMPRESSION_ERROR
The job was aborted by the system because the printer encountered an error in the document data while decompressing it. |
| public static final 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 |
| public static final JobStateReason | DOCUMENT_FORMAT_ERROR
The job was aborted by the system because the printer encountered an error in the document data while processing it. |
| public static final JobStateReason | JOB_CANCELED_AT_DEVICE
The job was canceled by an unidentified local user, i.e., a user at a console at the device. |
| public static final 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). |
| public static final 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. |
| public static final JobStateReason | JOB_COMPLETED_SUCCESSFULLY
The job completed successfully. |
| public static final JobStateReason | JOB_COMPLETED_WITH_ERRORS
The job completed with errors (and possibly warnings too). |
| public static final JobStateReason | JOB_COMPLETED_WITH_WARNINGS
The job completed with warnings. |
| public static final 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
|
| public static final JobStateReason | JOB_HOLD_UNTIL_SPECIFIED
The value of the job's |
| public static final JobStateReason | JOB_INCOMING
The printer has created the Print Job, but the printer has not finished accessing or accepting all the print data yet. |
| public static final JobStateReason | JOB_INTERPRETING
The job is in the |
| public static final JobStateReason | JOB_OUTGOING
The printer is transmitting the job to the output device. |
| public static final JobStateReason | JOB_PRINTING
The output device is marking media. |
| public static final JobStateReason | JOB_QUEUED
The job is in the |
| public static final JobStateReason | JOB_QUEUED_FOR_MARKER
The job is in the |
| public static final JobStateReason | JOB_RESTARTABLE
This job is retained and is currently able to be restarted. |
| public static final JobStateReason | JOB_TRANSFORMING
The job is in the |
| private static final JobStateReason[] | myEnumValueTable
The enumeration value table for class |
| private static final String[] | myStringTable
The string table for class |
| public static final JobStateReason | PRINTER_STOPPED
The value of the printer's |
| public static final JobStateReason | PRINTER_STOPPED_PARTLY
The value of the printer's |
| public static final 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. |
| public static final JobStateReason | QUEUED_IN_DEVICE
The job has been forwarded to a device or print system that is unable to send back status. |
| public static final 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. |
| private static final long | serialVersionUID
Use serialVersionUID from JDK 1.4 for interoperability.
|
| public static final JobStateReason | SERVICE_OFF_LINE
The printer is off-line and accepting no jobs. |
| public static final JobStateReason | SUBMISSION_INTERRUPTED
The job was not completely submitted for some unforeseen reason. |
| public static final 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. |
| public static final 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. |
| Access | Constructor and Description |
|---|---|
| protected | JobStateReason(int
Integer value value)Construct a new job state reason enumeration value with the given integer value. |
| Modifier and Type | Method and Description |
|---|---|
| public final Class | Returns: printing attribute class (category), an instance of classjava.Implements javax. Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
| protected EnumSyntax[] | getEnumValueTable()
Overrides javax. Returns the enumeration value table for class |
| public final String | Returns: attribute category nameImplements javax. Get the name of the category of which this attribute value is an instance. |
| protected String[] | getStringTable()
Overrides javax. Returns the string table for class |
| ABORTED_BY_SYSTEM | back to summary |
|---|---|
| public static final JobStateReason ABORTED_BY_SYSTEM The job was aborted by the system. Either the job (1) is in the process
of being aborted, (2) has been aborted by the system and placed in the
| |
| COMPRESSION_ERROR | back to summary |
|---|---|
| public static final JobStateReason COMPRESSION_ERROR The job was aborted by the system because the printer encountered an
error in the document data while decompressing it. If the printer posts
this reason, the document data has already passed any tests that would
have led to the | |
| DOCUMENT_ACCESS_ERROR | back to summary |
|---|---|
| public static final 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 | |
| DOCUMENT_FORMAT_ERROR | back to summary |
|---|---|
| public static final JobStateReason DOCUMENT_FORMAT_ERROR The job was aborted by the system because the printer encountered an
error in the document data while processing it. If the printer posts this
reason, the document data has already passed any tests that would have
led to the | |
| JOB_CANCELED_AT_DEVICE | back to summary |
|---|---|
| public static final JobStateReason JOB_CANCELED_AT_DEVICE The job was canceled by an unidentified local user, i.e., a user at a console at the device. This value should be supported if the implementation supports canceling jobs at the console. | |
| JOB_CANCELED_BY_OPERATOR | back to summary |
|---|---|
| public static final 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). If the security policy is to allow anyone to cancel anyone's job, then this value may be used when the job is canceled by someone other than the owner of the job. For such a security policy, in effect, everyone is an operator as far as canceling jobs is concerned. This value should be supported if the implementation permits canceling by someone other than the owner of the job. | |
| JOB_CANCELED_BY_USER | back to summary |
|---|---|
| public static final 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. This value should be supported. | |
| JOB_COMPLETED_SUCCESSFULLY | back to summary |
|---|---|
| public static final JobStateReason JOB_COMPLETED_SUCCESSFULLY The job completed successfully. This value should be supported. | |
| JOB_COMPLETED_WITH_ERRORS | back to summary |
|---|---|
| public static final JobStateReason JOB_COMPLETED_WITH_ERRORS The job completed with errors (and possibly warnings too). This value should be supported if the implementation detects errors. | |
| JOB_COMPLETED_WITH_WARNINGS | back to summary |
|---|---|
| public static final JobStateReason JOB_COMPLETED_WITH_WARNINGS The job completed with warnings. This value should be supported if the implementation detects warnings. | |
| JOB_DATA_INSUFFICIENT | back to summary |
|---|---|
| public static final 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
| |
| JOB_HOLD_UNTIL_SPECIFIED | back to summary |
|---|---|
| public static final JobStateReason JOB_HOLD_UNTIL_SPECIFIED The value of the job's | |
| JOB_INCOMING | back to summary |
|---|---|
| public static final JobStateReason JOB_INCOMING The printer has created the Print Job, but the printer has not finished accessing or accepting all the print data yet. | |
| JOB_INTERPRETING | back to summary |
|---|---|
| public static final JobStateReason JOB_INTERPRETING The job is in the | |
| JOB_OUTGOING | back to summary |
|---|---|
| public static final JobStateReason JOB_OUTGOING The printer is transmitting the job to the output device. | |
| JOB_PRINTING | back to summary |
|---|---|
| public static final JobStateReason JOB_PRINTING The output device is marking media. This value is useful for printers
which spend a great deal of time processing (1) when no marking is
happening and then want to show that marking is now happening or (2) when
the job is in the process of being canceled or aborted while the job
remains in the | |
| JOB_QUEUED | back to summary |
|---|---|
| public static final JobStateReason JOB_QUEUED The job is in the | |
| JOB_QUEUED_FOR_MARKER | back to summary |
|---|---|
| public static final JobStateReason JOB_QUEUED_FOR_MARKER The job is in the | |
| JOB_RESTARTABLE | back to summary |
|---|---|
| public static final JobStateReason JOB_RESTARTABLE This job is retained and is currently able to be restarted. If
| |
| JOB_TRANSFORMING | back to summary |
|---|---|
| public static final JobStateReason JOB_TRANSFORMING The job is in the | |
| myEnumValueTable | back to summary |
|---|---|
| private static final JobStateReason[] myEnumValueTable The enumeration value table for class | |
| myStringTable | back to summary |
|---|---|
| private static final String[] myStringTable The string table for class | |
| PRINTER_STOPPED | back to summary |
|---|---|
| public static final JobStateReason PRINTER_STOPPED The value of the printer's | |
| PRINTER_STOPPED_PARTLY | back to summary |
|---|---|
| public static final JobStateReason PRINTER_STOPPED_PARTLY The value of the printer's | |
| PROCESSING_TO_STOP_POINT | back to summary |
|---|---|
| public static final 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.
If the implementation requires some measurable time to cancel the job in
the | |
| QUEUED_IN_DEVICE | back to summary |
|---|---|
| public static final JobStateReason QUEUED_IN_DEVICE The job has been forwarded to a device or print system that is unable to
send back status. The printer sets the job's | |
| RESOURCES_ARE_NOT_READY | back to summary |
|---|---|
| public static final 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. This condition may be detected when the job
is accepted, or subsequently while the job is pending or processing,
depending on implementation. The job may remain in its current state or
be moved to the | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides javax. Use serialVersionUID from JDK 1.4 for interoperability. | |
| SERVICE_OFF_LINE | back to summary |
|---|---|
| public static final JobStateReason SERVICE_OFF_LINE The printer is off-line and accepting no jobs. All | |
| SUBMISSION_INTERRUPTED | back to summary |
|---|---|
| public static final JobStateReason SUBMISSION_INTERRUPTED The job was not completely submitted for some unforeseen reason. Possibilities include (1) the printer has crashed before the job was fully submitted by the client, (2) the printer or the document transfer method has crashed in some non-recoverable way before the document data was entirely transferred to the printer, (3) the client crashed before the job was fully submitted. | |
| UNSUPPORTED_COMPRESSION | back to summary |
|---|---|
| public static final 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. This value must be
supported, since | |
| UNSUPPORTED_DOCUMENT_FORMAT | back to summary |
|---|---|
| public static final 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. If the
client specifies a doc flavor with a MIME type of
| |
| JobStateReason | back to summary |
|---|---|
| protected JobStateReason(int value) Construct a new job state reason enumeration value with the given integer value.
| |
| getCategory | back to summary |
|---|---|
| public final Class Implements javax. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
For class
| |
| getEnumValueTable | back to summary |
|---|---|
| protected EnumSyntax[] getEnumValueTable() Overrides javax. Returns the enumeration value table for class
| |
| getName | back to summary |
|---|---|
| public final String getName() Implements javax. Get the name of the category of which this attribute value is an instance.
For class | |
| getStringTable | back to summary |
|---|---|
| protected String[] getStringTable() Overrides javax. Returns the string table for class
| |