src/share/classes/javax/print/attribute/standard/JobStateReason.java

Print this page




  34  * attribute. Class JobStateReason defines standard job state reason values. A
  35  * Print Service implementation only needs to report those job state
  36  * reasons which are appropriate for the particular implementation; it does not
  37  * have to report every defined job state reason.
  38  * <P>
  39  * Instances of JobStateReason do not appear in a Print Job's attribute set
  40  * directly. Rather, a {@link JobStateReasons JobStateReasons} attribute appears
  41  * in the Print Job's attribute set. The {@link JobStateReasons JobStateReasons}
  42  * attribute contains zero, one, or more than one JobStateReason objects which
  43  * pertain to the Print Job's status. The printer adds a JobStateReason object
  44  * to the Print Job's {@link JobStateReasons JobStateReasons} attribute when the
  45  * corresponding condition becomes true of the Print Job, and the printer
  46  * removes the JobStateReason object again when the corresponding condition
  47  * becomes false, regardless of whether the Print Job's overall {@link JobState
  48  * JobState} also changed.
  49  * <P>
  50  * <B>IPP Compatibility:</B> The category name returned by
  51  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's
  52  * integer value is the IPP enum value.  The <code>toString()</code> method
  53  * returns the IPP string representation of the attribute value.
  54  * <P>
  55  *
  56  * @author  Alan Kaminsky
  57  */
  58 public class JobStateReason extends EnumSyntax implements Attribute {
  59 
  60     private static final long serialVersionUID = -8765894420449009168L;
  61 
  62     /**
  63      * The printer has created the Print Job, but the printer has not finished
  64      * accessing or accepting all the print data yet.
  65      */
  66     public static final JobStateReason
  67         JOB_INCOMING = new JobStateReason(0);
  68 
  69     /**
  70      * The printer has created the Print Job, but the printer is expecting
  71      * additional print data before it can move the job into the PROCESSING
  72      * state. If a printer starts processing before it has received all data,
  73      * the printer removes the JOB_DATA_INSUFFICIENT reason, but the
  74      * JOB_INCOMING reason remains. If a printer starts processing after it




  34  * attribute. Class JobStateReason defines standard job state reason values. A
  35  * Print Service implementation only needs to report those job state
  36  * reasons which are appropriate for the particular implementation; it does not
  37  * have to report every defined job state reason.
  38  * <P>
  39  * Instances of JobStateReason do not appear in a Print Job's attribute set
  40  * directly. Rather, a {@link JobStateReasons JobStateReasons} attribute appears
  41  * in the Print Job's attribute set. The {@link JobStateReasons JobStateReasons}
  42  * attribute contains zero, one, or more than one JobStateReason objects which
  43  * pertain to the Print Job's status. The printer adds a JobStateReason object
  44  * to the Print Job's {@link JobStateReasons JobStateReasons} attribute when the
  45  * corresponding condition becomes true of the Print Job, and the printer
  46  * removes the JobStateReason object again when the corresponding condition
  47  * becomes false, regardless of whether the Print Job's overall {@link JobState
  48  * JobState} also changed.
  49  * <P>
  50  * <B>IPP Compatibility:</B> The category name returned by
  51  * <CODE>getName()</CODE> is the IPP attribute name.  The enumeration's
  52  * integer value is the IPP enum value.  The <code>toString()</code> method
  53  * returns the IPP string representation of the attribute value.

  54  *
  55  * @author  Alan Kaminsky
  56  */
  57 public class JobStateReason extends EnumSyntax implements Attribute {
  58 
  59     private static final long serialVersionUID = -8765894420449009168L;
  60 
  61     /**
  62      * The printer has created the Print Job, but the printer has not finished
  63      * accessing or accepting all the print data yet.
  64      */
  65     public static final JobStateReason
  66         JOB_INCOMING = new JobStateReason(0);
  67 
  68     /**
  69      * The printer has created the Print Job, but the printer is expecting
  70      * additional print data before it can move the job into the PROCESSING
  71      * state. If a printer starts processing before it has received all data,
  72      * the printer removes the JOB_DATA_INSUFFICIENT reason, but the
  73      * JOB_INCOMING reason remains. If a printer starts processing after it