| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class JobState extends EnumSyntax implements 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 {@link JobStateReasons 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.
Field Summary | |
---|---|
static JobState |
ABORTED
The job has been aborted by the system (usually while the job was in the PROCESSING or PROCESSING_STOPPED state), the printer has completed aborting the job, and all job status attributes have reached their final values for the job. |
static JobState |
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. |
static JobState |
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. |
static JobState |
PENDING
The job is a candidate to start processing, but is not yet processing. |
static JobState |
PENDING_HELD
The job is not a candidate for processing for any number of reasons but will return to the PENDING state as soon as the reasons are no longer present. |
static JobState |
PROCESSING
The job is processing. |
static JobState |
PROCESSING_STOPPED
The job has stopped while processing for any number of reasons and will return to the PROCESSING state as soon as the reasons are no longer present. |
static JobState |
UNKNOWN
The job state is unknown. |
Constructor Summary | |
---|---|
protected |
JobState(int value) Construct a new job state enumeration value with the given integer value. |
Method Summary | |
---|---|
Class |
Get 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 class JobState. |
String |
getName() Get the name of the category of which this attribute value is an instance. |
protected String[] |
Returns the string table for class JobState. |
Methods inherited from class javax.print.attribute.EnumSyntax |
---|
clone, getEnumValueTable, getOffset, getStringTable, getValue, hashCode, readResolve, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final JobState ABORTED
public static final JobState CANCELED
public static final JobState COMPLETED
public static final JobState PENDING
public static final JobState PENDING_HELD
public static final JobState PROCESSING
When the job is in the PROCESSING state, the entire job state includes the detailed status represented in the printer's {@link PrinterState PrinterState} and {@link PrinterStateReasons PrinterStateReasons} attributes.
Implementations may, though they need not, include additional values in the job's {@link JobStateReasons JobStateReasons} attribute to indicate the progress of the job, such as adding the JOB_PRINTING value to indicate when the output device is actually making marks on paper and/or the PROCESSING_TO_STOP_POINT value to indicate that the printer is in the process of canceling or aborting the job.
public static final JobState PROCESSING_STOPPED
The job's {@link JobStateReasons JobStateReasons} attribute may indicate why the job has stopped processing. For example, if the output device is stopped, the PRINTER_STOPPED value may be included in the job's {@link JobStateReasons JobStateReasons} 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 {@link PrinterState PrinterState} and {@link PrinterStateReasons PrinterStateReasons} attributes.
public static final JobState UNKNOWN
Constructor Detail |
---|
protected JobState(int value)
value
- Integer value.Method Detail |
---|
public final Class getCategory()
For class JobState and any vendor-defined subclasses, the category is class JobState itself.
protected EnumSyntax[] getEnumValueTable()
getEnumValueTable
in class EnumSyntax
public final String getName()
For class JobState and any vendor-defined subclasses, the category
name is "job-state"
.
protected String[] getStringTable()
getStringTable
in class EnumSyntax
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |