- All Implemented Interfaces:
Serializable
,Cloneable
,Attribute
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.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JobStateReason
The job was aborted by the system.static final JobStateReason
The job was aborted by the system because the printer encountered an error in the document data while decompressing it.static final JobStateReason
The printer could not access one or more documents passed by reference (i.e., the print data representation object is aURL
).static final JobStateReason
The job was aborted by the system because the printer encountered an error in the document data while processing it.static final JobStateReason
The job was canceled by an unidentified local user, i.e., a user at a console at the device.static final JobStateReason
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 final JobStateReason
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 final JobStateReason
The job completed successfully.static final JobStateReason
The job completed with errors (and possibly warnings too).static final JobStateReason
The job completed with warnings.static final JobStateReason
The printer has created the Print Job, but the printer is expecting additional print data before it can move the job into thePROCESSING
state.static final JobStateReason
The value of the job'sJobHoldUntil
attribute was specified with a date-time that is still in the future.static final JobStateReason
The printer has created the Print Job, but the printer has not finished accessing or accepting all the print data yet.static final JobStateReason
The job is in thePROCESSING
state, but more specifically, the printer ia interpreting the document data.static final JobStateReason
The printer is transmitting the job to the output device.static final JobStateReason
The output device is marking media.static final JobStateReason
The job is in thePROCESSING
state, but more specifically, the printer has queued the document data.static final JobStateReason
The job is in thePENDING_HELD
,PENDING
, orPROCESSING
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 final JobStateReason
This job is retained and is currently able to be restarted.static final JobStateReason
The job is in thePROCESSING
state, but more specifically, the printer is interpreting document data and producing another electronic representation.static final JobStateReason
The value of the printer'sPrinterState
attribute iaSTOPPED
.static final JobStateReason
The value of the printer'sPrinterStateReasons
attribute contains aPrinterStateReason
value ofSTOPPED_PARTLY
.static final JobStateReason
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 final JobStateReason
The job has been forwarded to a device or print system that is unable to send back status.static final JobStateReason
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 final JobStateReason
The printer is off-line and accepting no jobs.static final JobStateReason
The job was not completely submitted for some unforeseen reason.static final JobStateReason
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 final JobStateReason
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
ModifierConstructorDescriptionprotected
JobStateReason
(int value) Construct a new job state reason enumeration value with the given integer value. -
Method Summary
Modifier and TypeMethodDescriptionGet the printing attribute class which is to be used as the "category" for this printing attribute value.protected EnumSyntax[]
Returns the enumeration value table for classJobStateReason
.final String
getName()
Get the name of the category of which this attribute value is an instance.protected String[]
Returns the string table for classJobStateReason
.Methods declared in class javax.print.attribute.EnumSyntax
clone, getOffset, getValue, hashCode, readResolve, toString
-
Field Details
-
JOB_INCOMING
The printer has created the Print Job, but the printer has not finished accessing or accepting all the print data yet. -
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 thePROCESSING
state. If a printer starts processing before it has received all data, the printer removes theJOB_DATA_INSUFFICIENT
reason, but theJOB_INCOMING
reason remains. If a printer starts processing after it has received all data, the printer removes theJOB_DATA_INSUFFICIENT
andJOB_INCOMING
reasons at the same time. -
DOCUMENT_ACCESS_ERROR
The printer could not access one or more documents passed by reference (i.e., the print data representation object is aURL
). This reason is intended to cover any file access problem, including file does not exist and access denied because of an access control problem. Whether the printer aborts the job and moves the job to theABORTED
job state or prints all documents that are accessible and moves the job to theCOMPLETED
job state and adds theCOMPLETED_WITH_ERRORS
reason to the job'sJobStateReasons
attribute depends on implementation and/or site policy. This value should be supported if the printer supports doc flavors withURL
print data representation objects. -
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. -
JOB_OUTGOING
The printer is transmitting the job to the output device. -
JOB_HOLD_UNTIL_SPECIFIED
The value of the job'sJobHoldUntil
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 theJobHoldUntil
job template attribute is supported. -
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 thePENDING_HELD
state, depending on implementation and/or job scheduling policy. -
PRINTER_STOPPED_PARTLY
The value of the printer'sPrinterStateReasons
attribute contains aPrinterStateReason
value ofSTOPPED_PARTLY
. -
PRINTER_STOPPED
The value of the printer'sPrinterState
attribute iaSTOPPED
. -
JOB_INTERPRETING
The job is in thePROCESSING
state, but more specifically, the printer ia interpreting the document data. -
JOB_QUEUED
The job is in thePROCESSING
state, but more specifically, the printer has queued the document data. -
JOB_TRANSFORMING
The job is in thePROCESSING
state, but more specifically, the printer is interpreting document data and producing another electronic representation. -
JOB_QUEUED_FOR_MARKER
The job is in thePENDING_HELD
,PENDING
, orPROCESSING
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. Systems that require human intervention to release jobs put the job into thePENDING_HELD
job state. Systems that automatically select a job to use the marker put the job into thePENDING
job state or keep the job in thePROCESSING
job state while waiting for the marker, depending on implementation. All implementations put the job into (or back into) thePROCESSING
state when marking does begin. -
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 thePROCESSING
state, but the marking has not yet stopped so that impression or sheet counts are still increasing for the job. -
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_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_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. -
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 theABORTED
state, or (3) has been aborted by the system and placed in thePENDING_HELD
state, so that a user or operator can manually try the job again. This value should be supported. -
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, sinceCompression
is a required doc description attribute. -
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 theUNSUPPORTED_COMPRESSION
job state reason. -
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"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. -
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 theUNSUPPORTED_DOCUMENT_FORMAT
job state reason. -
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
PROCESSING
orPROCESSING_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 thePROCESSING
orPROCESSING_STOPPED
state. After all the job's job description attributes have stopped incrementing, the printer moves the job from the PROCESSING state to theCANCELED
orABORTED
job states. -
SERVICE_OFF_LINE
The printer is off-line and accepting no jobs. AllPENDING
jobs are put into thePENDING_HELD
state. This situation could be true if the service's or document transform's input is impaired or broken. -
JOB_COMPLETED_SUCCESSFULLY
The job completed successfully. This value should be supported. -
JOB_COMPLETED_WITH_WARNINGS
The job completed with warnings. This value should be supported if the implementation detects warnings. -
JOB_COMPLETED_WITH_ERRORS
The job completed with errors (and possibly warnings too). This value should be supported if the implementation detects errors. -
JOB_RESTARTABLE
This job is retained and is currently able to be restarted. IfJOB_RESTARTABLE
is contained in the job'sJobStateReasons
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.] -
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'sJobState
attribute toCOMPLETED
and adds theQUEUED_IN_DEVICE
reason to the job'sJobStateReasons
attribute to indicate that the printer has no additional information about the job and never will have any better information.
-
-
Constructor Details
-
JobStateReason
protected JobStateReason(int value) Construct a new job state reason enumeration value with the given integer value.- Parameters:
value
- Integer value
-
-
Method Details
-
getStringTable
Returns the string table for classJobStateReason
.- Overrides:
getStringTable
in classEnumSyntax
- Returns:
- the string table
-
getEnumValueTable
Returns the enumeration value table for classJobStateReason
.- Overrides:
getEnumValueTable
in classEnumSyntax
- Returns:
- the value table
-
getCategory
Get the printing attribute class which is to be used as the "category" for this printing attribute value.For class
JobStateReason
and any vendor-defined subclasses, the category is classJobStateReason
itself.- Specified by:
getCategory
in interfaceAttribute
- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
getName
Get the name of the category of which this attribute value is an instance.For class
JobStateReason
and any vendor-defined subclasses, the category name is"job-state-reason"
.
-