javax.print.attribute.standard
クラス JobState

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 ジョブは処理中であり、次のアクティビティが 1 つ以上発生しています。
static JobState	PROCESSING_STOPPED いくつかの原因で、ジョブが処理中に停止されています。
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

クラス java.lang.Object から継承されたメソッド

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

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 つ以上発生しています。

1. PDL 等の分析、生成、変換を行う、1 つ以上の純粋なソフトウェアプロセスをジョブが使用中、または使用試行中

2. PDL 変換、媒体へのマーキング、またはステープリングなどの仕上げ処理を行う、1 つ以上のハードウェアデバイスをジョブが使用中、または使用試行中

3. プリンタの印刷準備は完了しているが、ジョブが出力デバイスに到着していないため、または出力デバイスか別のスプーラのキューに入っていて印刷待ち状態になっているため、出力デバイスで印刷がまだ実行されていない

ジョブの状態が 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 のいずれかである必要があります。

コンストラクタの詳細

JobState

protected JobState(int value)

指定された整数値を使用して新しいジョブ状態列挙値を構築します。

パラメータ:

value - 整数値

メソッドの詳細

getStringTable

protected String[] getStringTable()

JobState クラスの文字列テーブルを返します。

オーバーライド:

クラス EnumSyntax 内の getStringTable

戻り値:

文字列テーブル

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()

JobState クラスの列挙値テーブルを返します。

オーバーライド:

クラス EnumSyntax 内の getEnumValueTable

戻り値:

値テーブル

getCategory

public final Class<? extends Attribute> getCategory()

この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

JobState クラス、およびベンダー定義の任意のサブクラスでは、カテゴリは JobState クラス自身になります。

定義:

インタフェース Attribute 内の getCategory

戻り値:

印刷属性クラス (カテゴリ)、java.lang.Class クラスのインスタンス

getName

public final String getName()

属性値がインスタンスとなるカテゴリの名前を返します。

JobState クラス、およびベンダー定義の任意のサブクラスでは、カテゴリ名は job-state になります。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリの名前