javax.print.attribute.standard
Class JobStateReason

java.lang.Object
  extended by javax.print.attribute.EnumSyntax
      extended by javax.print.attribute.standard.JobStateReason
All Implemented Interfaces:
Serializable, Cloneable, Attribute

public class JobStateReason
extends EnumSyntax
implements Attribute

The JobStateReason attribute provides additional information about the current state of a job. Its always part of the JobStateReasons printing attribute.

IPP Compatibility: JobStateReason is not an IPP 1.1 attribute itself but used inside the JobStateReasons attribute.

See Also:
Serialized Form

Field Summary
static JobStateReason ABORTED_BY_SYSTEM
          The job has been aborted by the system.
static JobStateReason COMPRESSION_ERROR
          The printer aborted the job because of a compression error while trying to decompress the document data.
static JobStateReason DOCUMENT_ACCESS_ERROR
          The printer is unable to access one or more documents provided by reference in the print job.
static JobStateReason DOCUMENT_FORMAT_ERROR
          The printer aborted the job because of an error in the document data.
static JobStateReason JOB_CANCELED_AT_DEVICE
          The job was canceled by an unidentified local user at the device.
static JobStateReason JOB_CANCELED_BY_OPERATOR
          The job was canceled by the operator.
static JobStateReason JOB_CANCELED_BY_USER
          The job was canceled by the user (the owner of the job).
static JobStateReason JOB_COMPLETED_SUCCESSFULLY
          The printer completed the job successfully.
static JobStateReason JOB_COMPLETED_WITH_ERRORS
          The printer completed the job with errors.
static JobStateReason JOB_COMPLETED_WITH_WARNINGS
          The printer completed the job with warnings.
static JobStateReason JOB_DATA_INSUFFICIENT
          The printer is expecting additional document data before it can move this job into the processing state.
static JobStateReason JOB_HOLD_UNTIL_SPECIFIED
          The job was submitted with a JobHoldUntil attribute which specifies a time period still in the future and causes the job to be on hold.
static JobStateReason JOB_INCOMING
          The printer has accepted the job or is retrieving document data for processing.
static JobStateReason JOB_INTERPRETING
          The printer is currently interpreting the jobs document data.
static JobStateReason JOB_OUTGOING
          The printer transfers the job to the actual output device.
static JobStateReason JOB_PRINTING
          The job is currently printing.
static JobStateReason JOB_QUEUED
          The printer has queued the document data.
static JobStateReason JOB_QUEUED_FOR_MARKER
          The job is queued for marking.
static JobStateReason JOB_RESTARTABLE
          The job is retained and is able to be restared.
static JobStateReason JOB_TRANSFORMING
          The printer is transforming the document data to another representation.
static JobStateReason PRINTER_STOPPED
          The printer stopped complete.
static JobStateReason PRINTER_STOPPED_PARTLY
          The printer stopped partly.
static JobStateReason PROCESSING_TO_STOP_POINT
          The client has either canceled the job or the printer aborted the job.
static JobStateReason QUEUED_IN_DEVICE
          The printer has forwarded the job to the actual output device.
static JobStateReason RESOURCES_ARE_NOT_READY
          One or more resources needed by the job are not ready.
static JobStateReason SERVICE_OFF_LINE
          The printer is offline and therefore is not accepting jobs.
static JobStateReason SUBMISSION_INTERRUPTED
          The printer has not received the whole job submission.
static JobStateReason UNSUPPORTED_COMPRESSION
          The printer aborted the job because of an unsupported compression while trying to decompress the document data.
static JobStateReason UNSUPPORTED_DOCUMENT_FORMAT
          The printer aborted the job because of the document format is not supported.
 
Constructor Summary
protected JobStateReason(int value)
          Constructs a JobStateReason object.
 
Method Summary
 Class<? extends Attribute> getCategory()
          Returns category of this class.
protected  EnumSyntax[] getEnumValueTable()
          Returns a table with the enumeration values for this object.
 String getName()
          Returns the name of this attribute.
protected  String[] getStringTable()
          Returns a table with the enumeration values represented as strings for this object.
 
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

JOB_INCOMING

public static final JobStateReason JOB_INCOMING
The printer has accepted the job or is retrieving document data for processing.


JOB_DATA_INSUFFICIENT

public static final JobStateReason JOB_DATA_INSUFFICIENT
The printer is expecting additional document data before it can move this job into the processing state.


DOCUMENT_ACCESS_ERROR

public static final JobStateReason DOCUMENT_ACCESS_ERROR
The printer is unable to access one or more documents provided by reference in the print job.


SUBMISSION_INTERRUPTED

public static final JobStateReason SUBMISSION_INTERRUPTED
The printer has not received the whole job submission. This indicates no reason for the interruption.


JOB_OUTGOING

public static final JobStateReason JOB_OUTGOING
The printer transfers the job to the actual output device.


JOB_HOLD_UNTIL_SPECIFIED

public static final JobStateReason JOB_HOLD_UNTIL_SPECIFIED
The job was submitted with a JobHoldUntil attribute which specifies a time period still in the future and causes the job to be on hold.


RESOURCES_ARE_NOT_READY

public static final JobStateReason RESOURCES_ARE_NOT_READY
One or more resources needed by the job are not ready. E.g. needed media type.


PRINTER_STOPPED_PARTLY

public static final JobStateReason PRINTER_STOPPED_PARTLY
The printer stopped partly.


PRINTER_STOPPED

public static final JobStateReason PRINTER_STOPPED
The printer stopped complete.


JOB_INTERPRETING

public static final JobStateReason JOB_INTERPRETING
The printer is currently interpreting the jobs document data. Detailed state of the job's processing state.


JOB_QUEUED

public static final JobStateReason JOB_QUEUED
The printer has queued the document data. Detailed state of the job's processing state.


JOB_TRANSFORMING

public static final JobStateReason JOB_TRANSFORMING
The printer is transforming the document data to another representation. Detailed state of the job's processing state.


JOB_QUEUED_FOR_MARKER

public static final JobStateReason JOB_QUEUED_FOR_MARKER
The job is queued for marking.


JOB_PRINTING

public static final JobStateReason JOB_PRINTING
The job is currently printing.


JOB_CANCELED_BY_USER

public static final JobStateReason JOB_CANCELED_BY_USER
The job was canceled by the user (the owner of the job).


JOB_CANCELED_BY_OPERATOR

public static final JobStateReason JOB_CANCELED_BY_OPERATOR
The job was canceled by the operator.


JOB_CANCELED_AT_DEVICE

public static final JobStateReason JOB_CANCELED_AT_DEVICE
The job was canceled by an unidentified local user at the device.


ABORTED_BY_SYSTEM

public static final JobStateReason ABORTED_BY_SYSTEM
The job has been aborted by the system.


UNSUPPORTED_COMPRESSION

public static final JobStateReason UNSUPPORTED_COMPRESSION
The printer aborted the job because of an unsupported compression while trying to decompress the document data.


COMPRESSION_ERROR

public static final JobStateReason COMPRESSION_ERROR
The printer aborted the job because of a compression error while trying to decompress the document data. If this state is given the test for supported compression has already been passed.


UNSUPPORTED_DOCUMENT_FORMAT

public static final JobStateReason UNSUPPORTED_DOCUMENT_FORMAT
The printer aborted the job because of the document format is not supported. This may happen if a job is specified as application/octet-stream format.


DOCUMENT_FORMAT_ERROR

public static final JobStateReason DOCUMENT_FORMAT_ERROR
The printer aborted the job because of an error in the document data.


PROCESSING_TO_STOP_POINT

public static final JobStateReason PROCESSING_TO_STOP_POINT
The client has either canceled the job or the printer aborted the job. However the printer still performs some action on the job e.g. to cleanup.


SERVICE_OFF_LINE

public static final JobStateReason SERVICE_OFF_LINE
The printer is offline and therefore is not accepting jobs.


JOB_COMPLETED_SUCCESSFULLY

public static final JobStateReason JOB_COMPLETED_SUCCESSFULLY
The printer completed the job successfully.


JOB_COMPLETED_WITH_WARNINGS

public static final JobStateReason JOB_COMPLETED_WITH_WARNINGS
The printer completed the job with warnings.


JOB_COMPLETED_WITH_ERRORS

public static final JobStateReason JOB_COMPLETED_WITH_ERRORS
The printer completed the job with errors.


JOB_RESTARTABLE

public static final JobStateReason JOB_RESTARTABLE
The job is retained and is able to be restared.


QUEUED_IN_DEVICE

public static final JobStateReason QUEUED_IN_DEVICE
The printer has forwarded the job to the actual output device. This device is not capable of reporting the state back so that the job state is set to completed by the printer.

Constructor Detail

JobStateReason

protected JobStateReason(int value)
Constructs a JobStateReason object.

Parameters:
value - the enum value.
Method Detail

getCategory

public Class<? extends Attribute> getCategory()
Returns category of this class.

Specified by:
getCategory in interface Attribute
Returns:
The class JobStateReason itself.

getName

public final String getName()
Returns the name of this attribute.

Specified by:
getName in interface Attribute
Returns:
The name "job-state-reason".

getStringTable

protected String[] getStringTable()
Returns a table with the enumeration values represented as strings for this object.

Overrides:
getStringTable in class EnumSyntax
Returns:
The enumeration values as strings.

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()
Returns a table with the enumeration values for this object.

Overrides:
getEnumValueTable in class EnumSyntax
Returns:
The enumeration values.