1. /*

  2.  * @(#)JobState.java	1.4 03/01/23

  3.  *

  4.  * Copyright 2003 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package javax.print.attribute.standard;

  9. 

  10. import javax.print.attribute.EnumSyntax;

  11. import javax.print.attribute.PrintJobAttribute;

  12. 

  13. /**

  14.  * JobState is a printing attribute class, an enumeration, that identifies 

  15.  * the current state of a print job. Class JobState defines standard job state 

  16.  * values. A  Print Service implementation only needs to report those job 

  17.  * states which are appropriate for the particular implementation; it does not 

  18.  * have to report every defined job state. The {@link JobStateReasons 

  19.  * JobStateReasons} attribute augments the JobState attribute to give more 

  20.  * detailed information about the job in the given job state. 

  21.  * <P>

  22.  * <B>IPP Compatibility:</B> The category name returned by 

  23.  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's 

  24.  * integer value is the IPP enum value.  The <code>toString()</code> method 

  25.  * returns the IPP string representation of the attribute value.

  26.  * <P>

  27.  *

  28.  * @author  Alan Kaminsky

  29.  */

  30. 

  31. public class JobState extends EnumSyntax implements PrintJobAttribute {

  32. 

  33.     /**

  34.      * The job state is unknown.

  35.      */

  36.     public static final JobState UNKNOWN = new JobState(0);

  37.     

  38.     /**

  39.      * The job is a candidate to start processing, but is not yet processing. 

  40.      */

  41.     public static final JobState PENDING = new JobState(3);

  42.     

  43.     /**

  44.      * The job is not a candidate for processing for any number of reasons but 

  45.      * will return to the PENDING state as soon as the reasons are no longer 

  46.      * present. The job's {@link JobStateReasons JobStateReasons} attribute must 

  47.      * indicate why the job is no longer a candidate for processing. 

  48.      */

  49.     public static final JobState PENDING_HELD = new JobState(4);

  50.     

  51.     /**

  52.      * The job is processing. One or more of the following activities is 

  53.      * occurring: 

  54.      * <OL TYPE=1>

  55.      * <LI>

  56.      * The job is using, or is attempting to use, one or more purely software 

  57.      * processes that are analyzing, creating, or interpreting a PDL, etc. 

  58.      * <P>

  59.      * <LI>

  60.      * The job is using, or is attempting to use, one or more hardware 

  61.      * devices that are interpreting a PDL, making marks on a medium, and/or 

  62.      * performing finishing, such as stapling, etc.

  63.      * <P>

  64.      * <LI>

  65.      * The printer has made the job ready for printing, but the output 

  66.      * device is not yet printing it, either because the job hasn't reached the 

  67.      * output device or because the job is queued in the output device or some 

  68.      * other spooler, awaiting the output device to print it. 

  69.      * </OL>

  70.      * <P>

  71.      * When the job is in the PROCESSING state, the entire job state includes 

  72.      * the detailed status represented in the printer's {@link PrinterState 

  73.      * PrinterState} and {@link PrinterStateReasons PrinterStateReasons} 

  74.      * attributes. 

  75.      * <P>

  76.      * Implementations may, though they need not, include additional values in 

  77.      * the job's {@link JobStateReasons JobStateReasons} attribute to indicate 

  78.      * the progress of the job, such as adding the JOB_PRINTING value to 

  79.      * indicate when the output device is actually making marks on paper and/or 

  80.      * the PROCESSING_TO_STOP_POINT value to indicate that the printer is in the 

  81.      * process of canceling or aborting the job. 

  82.      */

  83.     public static final JobState PROCESSING = new JobState (5);

  84.     

  85.     /**

  86.      * The job has stopped while processing for any number of reasons and will 

  87.      * return to the PROCESSING state as soon as the reasons are no longer 

  88.      * present.

  89.      * <P>

  90.      * The job's {@link JobStateReasons JobStateReasons} attribute may indicate 

  91.      * why the job has stopped processing. For example, if the output device is 

  92.      * stopped, the PRINTER_STOPPED value may be included in the job's {@link 

  93.      * JobStateReasons JobStateReasons} attribute. 

  94.      * <P> 

  95.      * <I>Note:</I> When an output device is stopped, the device usually 

  96.      * indicates its condition in human readable form locally at the device. A 

  97.      * client can obtain more complete device status remotely by querying the 

  98.      * printer's {@link PrinterState PrinterState} and {@link 

  99.      * PrinterStateReasons PrinterStateReasons} attributes. 

  100.      */

  101.     public static final JobState PROCESSING_STOPPED = new JobState (6);

  102.     

  103.     /**

  104.      * The job has been canceled by some human agency, the printer has completed 

  105.      * canceling the job, and all job status attributes have reached their final 

  106.      * values for the job. While the printer is canceling the job, the job 

  107.      * remains in its current state, but the job's {@link JobStateReasons 

  108.      * JobStateReasons} attribute should contain the PROCESSING_TO_STOP_POINT 

  109.      * value and one of the CANCELED_BY_USER, CANCELED_BY_OPERATOR, or 

  110.      * CANCELED_AT_DEVICE values. When the job moves to the CANCELED state, the 

  111.      * PROCESSING_TO_STOP_POINT value, if present, must be removed, but the 

  112.      * CANCELED_BY_<I>xxx</I> value, if present, must remain. 

  113.      */

  114.     public static final JobState CANCELED = new JobState (7);

  115.     

  116.     /**

  117.      * The job has been aborted by the system (usually while the job was in the 

  118.      * PROCESSING or PROCESSING_STOPPED state), the printer has completed 

  119.      * aborting the job, and all job status attributes have reached their final 

  120.      * values for the job. While the printer is aborting the job, the job 

  121.      * remains in its current state, but the job's {@link JobStateReasons 

  122.      * JobStateReasons} attribute should contain the PROCESSING_TO_STOP_POINT 

  123.      * and ABORTED_BY_SYSTEM values. When the job moves to the ABORTED state, 

  124.      * the PROCESSING_TO_STOP_POINT value, if present, must be removed, but the 

  125.      * ABORTED_BY_SYSTEM value, if present, must remain. 

  126.      */

  127.     public static final JobState ABORTED = new JobState (8);

  128.     

  129.     /**

  130.      * The job has completed successfully or with warnings or errors after 

  131.      * processing, all of the job media sheets have been successfully stacked in 

  132.      * the appropriate output bin(s), and all job status attributes have reached 

  133.      * their final values for the job. The job's {@link JobStateReasons 

  134.      * JobStateReasons} attribute should contain one of these values: 

  135.      * COMPLETED_SUCCESSFULLY, COMPLETED_WITH_WARNINGS, or 

  136.      * COMPLETED_WITH_ERRORS. 

  137.      */

  138.     public static final JobState COMPLETED = new JobState (9);

  139.     

  140.     // Hidden constructors.

  141.     

  142.     /**

  143.      * Construct a new job state enumeration value with the given integer value. 

  144.      *

  145.      * @param  value  Integer value.

  146.      */

  147.     protected JobState(int value) {

  148. 	super (value);

  149.     }

  150.         

  151.     private static final String[] myStringTable =

  152.     {"unknown",

  153.      null,

  154.      null,

  155.      "pending",

  156.      "pending-held",

  157.      "processing",

  158.      "processing-stopped",

  159.      "canceled",

  160.      "aborted",

  161.      "completed"};

  162.     

  163.     private static final JobState[] myEnumValueTable =

  164.     {UNKNOWN,

  165.      null,

  166.      null,

  167.      PENDING,

  168.      PENDING_HELD,

  169.      PROCESSING,

  170.      PROCESSING_STOPPED,

  171.      CANCELED,

  172.      ABORTED,

  173.      COMPLETED};

  174.     

  175.     /**

  176.      * Returns the string table for class JobState.

  177.      */

  178.     protected String[] getStringTable() {

  179. 	return myStringTable;

  180.     }

  181.     

  182.     /**

  183.      * Returns the enumeration value table for class JobState.

  184.      */

  185.     protected EnumSyntax[] getEnumValueTable() {

  186. 	return myEnumValueTable;

  187.     }

  188.     

  189.     /**

  190.      * Get the printing attribute class which is to be used as the "category" 

  191.      * for this printing attribute value.

  192.      * <P>

  193.      * For class JobState and any vendor-defined subclasses, the category is 

  194.      * class JobState itself. 

  195.      *

  196.      * @return  Printing attribute class (category), an instance of class

  197.      *          {@link java.lang.Class java.lang.Class}.

  198.      */

  199.     public final Class getCategory() {

  200. 	return JobState.class;

  201.     }

  202.     

  203.     /**

  204.      * Get the name of the category of which this attribute value is an 

  205.      * instance. 

  206.      * <P>

  207.      * For class JobState and any vendor-defined subclasses, the category

  208.      * name is <CODE>"job-state"</CODE>.

  209.      *

  210.      * @return  Attribute category name.

  211.      */

  212.     public final String getName() {

  213. 	return "job-state";

  214.     }

  215.     

  216. }