- All Implemented Interfaces:
Serializable
,Cloneable
,Attribute
,PrintJobAttribute
JobState
is a printing attribute class, an enumeration, that
identifies the current state of a print job. Class JobState
defines
standard job state values. A Print Service implementation only needs to
report those job states which are appropriate for the particular
implementation; it does not have to report every defined job state. The
JobStateReasons
attribute augments the
JobState
attribute to give more detailed information about the job in
the given job state.
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 JobState
The job has been aborted by the system (usually while the job was in thePROCESSING
orPROCESSING_STOPPED
state), the printer has completed aborting the job, and all job status attributes have reached their final values for the job.static final JobState
The job has been canceled by some human agency, the printer has completed canceling the job, and all job status attributes have reached their final values for the job.static final JobState
The job has completed successfully or with warnings or errors after processing, all of the job media sheets have been successfully stacked in the appropriate output bin(s), and all job status attributes have reached their final values for the job.static final JobState
The job is a candidate to start processing, but is not yet processing.static final JobState
The job is not a candidate for processing for any number of reasons but will return to thePENDING
state as soon as the reasons are no longer present.static final JobState
The job is processing.static final JobState
The job has stopped while processing for any number of reasons and will return to thePROCESSING
state as soon as the reasons are no longer present.static final JobState
The job state is unknown. -
Constructor Summary
ModifierConstructorDescriptionprotected
JobState
(int value) Construct a new job state 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 classJobState
.final String
getName()
Get the name of the category of which this attribute value is an instance.protected String[]
Returns the string table for classJobState
.Methods declared in class javax.print.attribute.EnumSyntax
clone, getOffset, getValue, hashCode, readResolve, toString
-
Field Details
-
UNKNOWN
The job state is unknown. -
PENDING
The job is a candidate to start processing, but is not yet processing. -
PENDING_HELD
The job is not a candidate for processing for any number of reasons but will return to thePENDING
state as soon as the reasons are no longer present. The job'sJobStateReasons
attribute must indicate why the job is no longer a candidate for processing. -
PROCESSING
The job is processing. One or more of the following activities is occurring:- The job is using, or is attempting to use, one or more purely software processes that are analyzing, creating, or interpreting a PDL, etc.
- The job is using, or is attempting to use, one or more hardware devices that are interpreting a PDL, making marks on a medium, and/or performing finishing, such as stapling, etc.
- The printer has made the job ready for printing, but the output device is not yet printing it, either because the job hasn't reached the output device or because the job is queued in the output device or some other spooler, awaiting the output device to print it.
PROCESSING
state, the entire job state includes the detailed status represented in the printer'sPrinterState
andPrinterStateReasons
attributes.Implementations may, though they need not, include additional values in the job's
JobStateReasons
attribute to indicate the progress of the job, such as adding theJOB_PRINTING
value to indicate when the output device is actually making marks on paper and/or thePROCESSING_TO_STOP_POINT
value to indicate that the printer is in the process of canceling or aborting the job. -
PROCESSING_STOPPED
The job has stopped while processing for any number of reasons and will return to thePROCESSING
state as soon as the reasons are no longer present.The job's
JobStateReasons
attribute may indicate why the job has stopped processing. For example, if the output device is stopped, thePRINTER_STOPPED
value may be included in the job'sJobStateReasons
attribute.Note: When an output device is stopped, the device usually indicates its condition in human readable form locally at the device. A client can obtain more complete device status remotely by querying the printer's
PrinterState
andPrinterStateReasons
attributes. -
CANCELED
The job has been canceled by some human agency, the printer has completed canceling the job, and all job status attributes have reached their final values for the job. While the printer is canceling the job, the job remains in its current state, but the job'sJobStateReasons
attribute should contain thePROCESSING_TO_STOP_POINT
value and one of theCANCELED_BY_USER
,CANCELED_BY_OPERATOR
, orCANCELED_AT_DEVICE
values. When the job moves to theCANCELED
state, thePROCESSING_TO_STOP_POINT
value, if present, must be removed, but the CANCELED_BY_xxx value, if present, must remain. -
ABORTED
The job has been aborted by the system (usually while the job was in thePROCESSING
orPROCESSING_STOPPED
state), the printer has completed aborting the job, and all job status attributes have reached their final values for the job. While the printer is aborting the job, the job remains in its current state, but the job'sJobStateReasons
attribute should contain thePROCESSING_TO_STOP_POINT
andABORTED_BY_SYSTEM
values. When the job moves to theABORTED
state, thePROCESSING_TO_STOP_POINT
value, if present, must be removed, but theABORTED_BY_SYSTEM
value, if present, must remain. -
COMPLETED
The job has completed successfully or with warnings or errors after processing, all of the job media sheets have been successfully stacked in the appropriate output bin(s), and all job status attributes have reached their final values for the job. The job'sJobStateReasons
attribute should contain one of these values:COMPLETED_SUCCESSFULLY
,COMPLETED_WITH_WARNINGS
, orCOMPLETED_WITH_ERRORS
.
-
-
Constructor Details
-
JobState
protected JobState(int value) Construct a new job state enumeration value with the given integer value.- Parameters:
value
- Integer value
-
-
Method Details
-
getStringTable
Returns the string table for classJobState
.- Overrides:
getStringTable
in classEnumSyntax
- Returns:
- the string table
-
getEnumValueTable
Returns the enumeration value table for classJobState
.- 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
JobState
and any vendor-defined subclasses, the category is classJobState
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
JobState
and any vendor-defined subclasses, the category name is"job-state"
.
-