Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute.standard
Class JobState

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax 
      extended by javax.print.attribute.standard.JobState
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute , PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute 
public class JobState
extends EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax 
implements PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.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 sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.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:
Serialized Form

Field Summary
static JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState ABORTED sample code for javax.print.attribute.standard.JobState.ABORTED definition code for javax.print.attribute.standard.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 sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState CANCELED sample code for javax.print.attribute.standard.JobState.CANCELED definition code for javax.print.attribute.standard.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 sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState COMPLETED sample code for javax.print.attribute.standard.JobState.COMPLETED definition code for javax.print.attribute.standard.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 sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState PENDING sample code for javax.print.attribute.standard.JobState.PENDING definition code for javax.print.attribute.standard.JobState.PENDING
          The job is a candidate to start processing, but is not yet processing.
static JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState PENDING_HELD sample code for javax.print.attribute.standard.JobState.PENDING_HELD definition code for javax.print.attribute.standard.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 sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState PROCESSING sample code for javax.print.attribute.standard.JobState.PROCESSING definition code for javax.print.attribute.standard.JobState.PROCESSING
          The job is processing.
static JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState PROCESSING_STOPPED sample code for javax.print.attribute.standard.JobState.PROCESSING_STOPPED definition code for javax.print.attribute.standard.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 sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState UNKNOWN sample code for javax.print.attribute.standard.JobState.UNKNOWN definition code for javax.print.attribute.standard.JobState.UNKNOWN
          The job state is unknown.
 
Constructor Summary
protected JobState sample code for javax.print.attribute.standard.JobState.JobState(int) definition code for javax.print.attribute.standard.JobState.JobState(int) (int value)
          Construct a new job state enumeration value with the given integer value.
 
Method Summary
 Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > getCategory sample code for javax.print.attribute.standard.JobState.getCategory() definition code for javax.print.attribute.standard.JobState.getCategory() ()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
protected  EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax [] getEnumValueTable sample code for javax.print.attribute.standard.JobState.getEnumValueTable() definition code for javax.print.attribute.standard.JobState.getEnumValueTable() ()
          Returns the enumeration value table for class JobState.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.print.attribute.standard.JobState.getName() definition code for javax.print.attribute.standard.JobState.getName() ()
          Get the name of the category of which this attribute value is an instance.
protected  String sample code for java.lang.String definition code for java.lang.String [] getStringTable sample code for javax.print.attribute.standard.JobState.getStringTable() definition code for javax.print.attribute.standard.JobState.getStringTable() ()
          Returns the string table for class JobState.
 
Methods inherited from class javax.print.attribute.EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
clone sample code for javax.print.attribute.EnumSyntax.clone() definition code for javax.print.attribute.EnumSyntax.clone() , getOffset sample code for javax.print.attribute.EnumSyntax.getOffset() definition code for javax.print.attribute.EnumSyntax.getOffset() , getValue sample code for javax.print.attribute.EnumSyntax.getValue() definition code for javax.print.attribute.EnumSyntax.getValue() , hashCode sample code for javax.print.attribute.EnumSyntax.hashCode() definition code for javax.print.attribute.EnumSyntax.hashCode() , readResolve sample code for javax.print.attribute.EnumSyntax.readResolve() definition code for javax.print.attribute.EnumSyntax.readResolve() , toString sample code for javax.print.attribute.EnumSyntax.toString() definition code for javax.print.attribute.EnumSyntax.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

UNKNOWN sample code for javax.print.attribute.standard.JobState.UNKNOWN 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState  UNKNOWN
The job state is unknown.

PENDING sample code for javax.print.attribute.standard.JobState.PENDING 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState  PENDING
The job is a candidate to start processing, but is not yet processing.

PENDING_HELD sample code for javax.print.attribute.standard.JobState.PENDING_HELD 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.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. The job's JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.JobStateReasons attribute must indicate why the job is no longer a candidate for processing.

PROCESSING sample code for javax.print.attribute.standard.JobState.PROCESSING 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.JobState  PROCESSING
The job is processing. One or more of the following activities is occurring:
  1. The job is using, or is attempting to use, one or more purely software processes that are analyzing, creating, or interpreting a PDL, etc.

  2. 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.

  3. 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.

When the job is in the PROCESSING state, the entire job state includes the detailed status represented in the printer's PrinterState sample code for javax.print.attribute.standard.PrinterState definition code for javax.print.attribute.standard.PrinterState and PrinterStateReasons sample code for javax.print.attribute.standard.PrinterStateReasons definition code for javax.print.attribute.standard.PrinterStateReasons attributes.

Implementations may, though they need not, include additional values in the job's JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.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.

PROCESSING_STOPPED sample code for javax.print.attribute.standard.JobState.PROCESSING_STOPPED 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.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.

The job's JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.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 JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.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 PrinterState sample code for javax.print.attribute.standard.PrinterState definition code for javax.print.attribute.standard.PrinterState and PrinterStateReasons sample code for javax.print.attribute.standard.PrinterStateReasons definition code for javax.print.attribute.standard.PrinterStateReasons attributes.

CANCELED sample code for javax.print.attribute.standard.JobState.CANCELED 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.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. While the printer is canceling the job, the job remains in its current state, but the job's JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.JobStateReasons attribute should contain the PROCESSING_TO_STOP_POINT value and one of the CANCELED_BY_USER, CANCELED_BY_OPERATOR, or CANCELED_AT_DEVICE values. When the job moves to the CANCELED state, the PROCESSING_TO_STOP_POINT value, if present, must be removed, but the CANCELED_BY_xxx value, if present, must remain.

ABORTED sample code for javax.print.attribute.standard.JobState.ABORTED 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.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. While the printer is aborting the job, the job remains in its current state, but the job's JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.JobStateReasons attribute should contain the PROCESSING_TO_STOP_POINT and ABORTED_BY_SYSTEM values. When the job moves to the ABORTED state, the PROCESSING_TO_STOP_POINT value, if present, must be removed, but the ABORTED_BY_SYSTEM value, if present, must remain.

COMPLETED sample code for javax.print.attribute.standard.JobState.COMPLETED 

public static final JobState sample code for javax.print.attribute.standard.JobState definition code for javax.print.attribute.standard.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. The job's JobStateReasons sample code for javax.print.attribute.standard.JobStateReasons definition code for javax.print.attribute.standard.JobStateReasons attribute should contain one of these values: COMPLETED_SUCCESSFULLY, COMPLETED_WITH_WARNINGS, or COMPLETED_WITH_ERRORS.

Constructor Detail

JobState sample code for javax.print.attribute.standard.JobState(int) definition code for javax.print.attribute.standard.JobState(int) 

protected JobState(int value)
Construct a new job state enumeration value with the given integer value.

Parameters:
value - Integer value.
Method Detail

getStringTable sample code for javax.print.attribute.standard.JobState.getStringTable() definition code for javax.print.attribute.standard.JobState.getStringTable() 

protected String sample code for java.lang.String definition code for java.lang.String [] getStringTable()
Returns the string table for class JobState.

Overrides:
getStringTable sample code for javax.print.attribute.EnumSyntax.getStringTable() definition code for javax.print.attribute.EnumSyntax.getStringTable() in class EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
Returns:
the string table

getEnumValueTable sample code for javax.print.attribute.standard.JobState.getEnumValueTable() definition code for javax.print.attribute.standard.JobState.getEnumValueTable() 

protected EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax [] getEnumValueTable()
Returns the enumeration value table for class JobState.

Overrides:
getEnumValueTable sample code for javax.print.attribute.EnumSyntax.getEnumValueTable() definition code for javax.print.attribute.EnumSyntax.getEnumValueTable() in class EnumSyntax sample code for javax.print.attribute.EnumSyntax definition code for javax.print.attribute.EnumSyntax
Returns:
the value table

getCategory sample code for javax.print.attribute.standard.JobState.getCategory() definition code for javax.print.attribute.standard.JobState.getCategory() 

public final Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > 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 class JobState itself.

Specified by:
getCategory sample code for javax.print.attribute.Attribute.getCategory() definition code for javax.print.attribute.Attribute.getCategory() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class sample code for java.lang.Class definition code for java.lang.Class .

getName sample code for javax.print.attribute.standard.JobState.getName() definition code for javax.print.attribute.standard.JobState.getName() 

public final String sample code for java.lang.String definition code for java.lang.String  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".

Specified by:
getName sample code for javax.print.attribute.Attribute.getName() definition code for javax.print.attribute.Attribute.getName() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Attribute category name.
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD