javax.print.attribute.standard

Class JobStateReason

java.lang.Object
- javax.print.attribute.EnumSyntax
- - javax.print.attribute.standard.JobStateReason

Implemented Interfaces:: Attribute, Cloneable, Serializable

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
`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`, `getEnumValueTable`, `getOffset`, `getStringTable`, `getValue`, `hashCode`, `readResolve`, `toString`

Methods inherited from class java.lang.Object
`clone`, `equals`, `extends Object> getClass`, `finalize`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait`

ABORTED_BY_SYSTEM

public static final JobStateReason ABORTED_BY_SYSTEM

The job has been aborted by the system.

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.

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.

DOCUMENT_FORMAT_ERROR

public static final JobStateReason DOCUMENT_FORMAT_ERROR

The printer aborted the job because of an error in the document data.

JOB_CANCELED_AT_DEVICE

public static final JobStateReason JOB_CANCELED_AT_DEVICE

The job was canceled by an unidentified local user at the device.

JOB_CANCELED_BY_OPERATOR

public static final JobStateReason JOB_CANCELED_BY_OPERATOR

The job was canceled by the operator.

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_COMPLETED_SUCCESSFULLY

public static final JobStateReason JOB_COMPLETED_SUCCESSFULLY

The printer completed the job successfully.

JOB_COMPLETED_WITH_ERRORS

public static final JobStateReason JOB_COMPLETED_WITH_ERRORS

The printer completed the job with errors.

JOB_COMPLETED_WITH_WARNINGS

public static final JobStateReason JOB_COMPLETED_WITH_WARNINGS

The printer completed the job with warnings.

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.

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.

JOB_INCOMING

public static final JobStateReason JOB_INCOMING

The printer has accepted the job or is retrieving document data for processing.

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_OUTGOING

public static final JobStateReason JOB_OUTGOING

The printer transfers the job to the actual output device.

JOB_PRINTING

public static final JobStateReason JOB_PRINTING

The job is currently printing.

JOB_QUEUED

public static final JobStateReason JOB_QUEUED

The printer has queued the document data. 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_RESTARTABLE

public static final JobStateReason JOB_RESTARTABLE

The job is retained and is able to be restared.

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.

PRINTER_STOPPED

public static final JobStateReason PRINTER_STOPPED

The printer stopped complete.

PRINTER_STOPPED_PARTLY

public static final JobStateReason PRINTER_STOPPED_PARTLY

The printer stopped partly.

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.

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.

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.

SERVICE_OFF_LINE

public static final JobStateReason SERVICE_OFF_LINE

The printer is offline and therefore is not accepting jobs.

SUBMISSION_INTERRUPTED

public static final JobStateReason SUBMISSION_INTERRUPTED

The printer has not received the whole job submission. This indicates no reason for the interruption.

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.

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.

JobStateReason

protected JobStateReason(int value)

Constructs a JobStateReason object.
Parameters:
value - the enum value.

? extends Attribute> getCategory

public Class< ? extends Attribute> getCategory()

Returns category of this class.
Specified by:
? extends Attribute> getCategory in interface Attribute
Returns:
The class JobStateReason itself.

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()

Returns a table with the enumeration values for this object.
Overrides:
getEnumValueTable in interface EnumSyntax
Returns:
The enumeration values.

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 interface EnumSyntax
Returns:
The enumeration values as strings.

JobStateReason.java -- Copyright (C) 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr