- java.lang.Object
-
- javax.print.attribute.EnumSyntax
-
- javax.print.attribute.standard.JobState
-
- すべての実装されたインタフェース:
Serializable
,Cloneable
,Attribute
,PrintJobAttribute
public class JobState extends EnumSyntax implements PrintJobAttribute
JobStateは印刷ジョブの現在の状態を識別して列挙する印刷属性クラスです。 JobStateクラスはジョブの状態を表す標準値を定義します。 印刷サービスが実装される場合、実装に適合するジョブの状態のみを通知する必要があります。定義されたすべての状態を通知する必要はありません。JobStateReasons
属性はJobState属性を拡張し、ある状態のジョブについてより詳細な情報を提供します。IPP互換性:
getName()
によって返されるカテゴリ名はIPP属性の名前です。 列挙の整数値はIPP列挙型値です。toString()
メソッドは、属性値のIPP文字列表現を返します。- 関連項目:
- 直列化された形式
-
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static JobState
ABORTED
通常、ジョブの状態がPROCESSINGまたはPROCESSING_STOPPEDのときに、システム側でジョブが取り消され、プリンタがジョブの取消しを完了し、すべてのジョブ状態属性がジョブの最終値に設定されています。static JobState
CANCELED
ユーザー側の操作でジョブが取り消され、プリンタがジョブの取消しを完了し、すべてのジョブ状態属性がジョブの最終値に設定されています。static JobState
COMPLETED
ジョブが正常に完了しているか、処理後に警告またはエラーが出され、印刷された用紙はすべて適切な出力トレーに排出され、すべてのジョブ状態属性がジョブの最終値に設定されています。static JobState
PENDING
ジョブは処理対象になっていますがまだ処理されていません。static JobState
PENDING_HELD
いくつかの原因でジョブが処理対象になっていませんが、これらが解決された時点で状態がPENDINGになります。static JobState
PROCESSING
ジョブは処理中です。static JobState
PROCESSING_STOPPED
いくつかの原因で、ジョブが処理中に停止されています。これらが解決された時点で状態がPROCESSINGに戻ります。static JobState
UNKNOWN
ジョブの状態は不明です。
-
コンストラクタのサマリー
コンストラクタ 修飾子 コンストラクタ 説明 protected
JobState(int value)
指定された整数値を使用して新しいジョブ状態列挙値を構築します。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 Class<? extends Attribute>
getCategory()
この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。protected EnumSyntax[]
getEnumValueTable()
JobStateクラスの列挙値テーブルを返します。String
getName()
属性値がインスタンスとなるカテゴリの名前を返します。protected String[]
getStringTable()
JobStateクラスの文字列テーブルを返します。-
クラス javax.print.attribute.EnumSyntaxから継承されたメソッド
clone, getOffset, getValue, hashCode, readResolve, toString
-
-
-
-
フィールドの詳細
-
UNKNOWN
public static final JobState UNKNOWN
ジョブの状態は不明です。
-
PENDING
public static final JobState PENDING
ジョブは処理対象になっていますがまだ処理されていません。
-
PENDING_HELD
public static final JobState PENDING_HELD
いくつかの原因でジョブが処理対象になっていませんが、これらが解決された時点で状態がPENDINGになります。 ジョブのJobStateReasons
属性で、ジョブが処理対象になっていない原因を示す必要があります。
-
PROCESSING
public static final JobState PROCESSING
ジョブは処理中です。 次のアクティビティが1つ以上発生しています。- PDL等の分析、生成、変換を行う、1つ以上の純粋なソフトウェア・プロセスをジョブが使用中、または使用試行中
- PDL変換、媒体へのマーキング、またはステープリングなどの終了処理を行う、1つ以上のハードウェア・デバイスをジョブが使用中、または使用試行中
- プリンタの印刷準備は完了しているが、ジョブが出力デバイスに到着していないため、または出力デバイスか別のスプーラのキューに入っていて印刷待ち状態になっているため、出力デバイスで印刷がまだ実行されていない
ジョブの状態がPROCESSINGのとき、ジョブ全体の状態に、プリンタの
PrinterState
およびPrinterStateReasons
属性で表される詳細なステータスが含まれます。ジョブの進捗を示すジョブの
JobStateReasons
属性の追加値が、必要がなくても実装に含まれる場合があります。出力デバイスが実際に用紙にマーキングするタイミングを示すJOB_PRINTING値や、プリンタがジョブの取り消しまたは中止を行なっていることを示すPROCESSING_TO_STOP_POINT値の追加がこれに該当します。
-
PROCESSING_STOPPED
public static final JobState PROCESSING_STOPPED
いくつかの原因で、ジョブが処理中に停止されています。これらが解決された時点で状態がPROCESSINGに戻ります。ジョブの
JobStateReasons
属性はジョブが処理を停止している原因を示します。 たとえば出力デバイスが停止している場合は、PRINTER_STOPPED値がジョブのJobStateReasons
属性に含まれていることがあります。注: 出力デバイスが停止しているときは、近くにいる人が認識できるような形で、そのデバイス自体が状態を表します。 クライアントからプリンタの
PrinterState
およびPrinterStateReasons
属性を照会することにより、デバイスのステータスをより完全に、リモートで取得することができます。
-
CANCELED
public static final JobState CANCELED
ユーザー側の操作でジョブが取り消され、プリンタがジョブの取消しを完了し、すべてのジョブ状態属性がジョブの最終値に設定されています。 プリンタでジョブが取り消されているときには、ジョブは現在の状態のまま残りますが、ジョブのJobStateReasons
属性にはPROCESSING_TO_STOP_POINT値、およびCANCELED_BY_USER、CANCELED_BY_OPERATOR、またはCANCELED_AT_DEVICEのいずれかの値が含まれるようにします。 ジョブの状態がCANCELEDに変わるときには、PROCESSING_TO_STOP_POINT値が残っている場合は削除する必要がありますが、CANCELED_BY_xxx値はそのまま残す必要があります。
-
ABORTED
public static final JobState ABORTED
通常、ジョブの状態がPROCESSINGまたはPROCESSING_STOPPEDのときに、システム側でジョブが取り消され、プリンタがジョブの取消しを完了し、すべてのジョブ状態属性がジョブの最終値に設定されています。 プリンタでジョブが中止されているときには、ジョブは現在の状態のまま残りますが、ジョブのJobStateReasons
属性にはPROCESSING_TO_STOP_POINT値、およびABORTED_BY_SYSTEM値を含めるようにします。 ジョブの状態がABORTEDに変わるときには、PROCESSING_TO_STOP_POINT値が残っている場合は削除する必要がありますが、ABORTED_BY_SYSTEM値はそのまま残す必要があります。
-
COMPLETED
public static final JobState COMPLETED
ジョブが正常に完了しているか、処理後に警告またはエラーが出され、印刷された用紙はすべて適切な出力トレーに排出され、すべてのジョブ状態属性がジョブの最終値に設定されています。 ジョブのJobStateReasons
属性に含める値は、COMPLETED_SUCCESSFULLY、COMPLETED_WITH_WARNINGS、またはCOMPLETED_WITH_ERRORSのいずれかである必要があります。
-
-
メソッドの詳細
-
getStringTable
protected String[] getStringTable()
JobStateクラスの文字列テーブルを返します。- オーバーライド:
getStringTable
、クラス:EnumSyntax
- 戻り値:
- 文字列テーブル
-
getEnumValueTable
protected EnumSyntax[] getEnumValueTable()
JobStateクラスの列挙値テーブルを返します。- オーバーライド:
getEnumValueTable
、クラス:EnumSyntax
- 戻り値:
- 値テーブル
-
getCategory
public final Class<? extends Attribute> getCategory()
この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。JobStateクラス、およびベンダー定義の任意のサブクラスでは、カテゴリはJobStateクラス自身になります。
- 定義:
getCategory
、インタフェース:Attribute
- 戻り値:
- 印刷属性クラス(カテゴリ)、
java.lang.Class
クラスのインスタンス。
-
-