javax.print.attribute.standard
Class JobState

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

public class JobState
extends EnumSyntax
implements PrintJobAttribute

The JobState printing attribute reports the current state of a job.

The JobStateReasons attribute provides further detailed information about the given job state. Detailed information about the job state and job state reasons can be found in the RFC 2911.

IPP Compatibility: JobState is an IPP 1.1 attribute.

See Also:
Serialized Form

Field Summary
static JobState ABORTED
          The job has been aborted by the system.
static JobState CANCELED
          The job has been canceled by the client.
static JobState COMPLETED
          The job has completed successfully.
static JobState PENDING
          The job is pending processing.
static JobState PENDING_HELD
          The job is currently not a candidate for printing because of reasons reported by the job-state-reasons attribute.
static JobState PROCESSING
          The job is currently processed.
static JobState PROCESSING_STOPPED
          The job's processing has stopped.
static JobState UNKNOWN
          The job state is currently unknown.
 
Constructor Summary
protected JobState(int value)
          Constructs a JobState 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

UNKNOWN

public static final JobState UNKNOWN
The job state is currently unknown.


PENDING

public static final JobState PENDING
The job is pending processing.


PENDING_HELD

public static final JobState PENDING_HELD
The job is currently not a candidate for printing because of reasons reported by the job-state-reasons attribute. If the reasons are no longer present it will return to the pending state.


PROCESSING

public static final JobState PROCESSING
The job is currently processed.


PROCESSING_STOPPED

public static final JobState PROCESSING_STOPPED
The job's processing has stopped. The job-state-reasons attribute may indicate the reason(s). The job will return to the processing state if the reasons are no longer present.


CANCELED

public static final JobState CANCELED
The job has been canceled by the client.


ABORTED

public static final JobState ABORTED
The job has been aborted by the system.


COMPLETED

public static final JobState COMPLETED
The job has completed successfully.

Constructor Detail

JobState

protected JobState(int value)
Constructs a JobState 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 JobState itself.

getName

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

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

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.