モジュール java.desktop

パッケージ 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 final JobState	ABORTED	ジョブはシステム(通常、ジョブがPROCESSINGまたはPROCESSING_STOPPED状態になっている間)によって中止され、プリンタはジョブを中止し、すべてのジョブ・ステータス属性がジョブの最終値に達しました。
static final JobState	CANCELED	ユーザー側の操作でジョブが取り消され、プリンタがジョブの取消しを完了し、すべてのジョブ状態属性がジョブの最終値に設定されています。
static final JobState	COMPLETED	ジョブが正常に完了しているか、処理後に警告またはエラーが出され、印刷された用紙はすべて適切な出力トレーに排出され、すべてのジョブ状態属性がジョブの最終値に設定されています。
static final JobState	PENDING	ジョブは処理対象になっていますがまだ処理されていません。
static final JobState	PENDING_HELD	ジョブは、いくつかの理由で処理する候補ではありませんが、理由がなくなるとすぐにPENDING状態に戻ります。
static final JobState	PROCESSING	ジョブは処理中です。
static final JobState	PROCESSING_STOPPED	ジョブは何らかの理由で処理中に停止し、その理由がなくなるとすぐにPROCESSING状態に戻ります。
static final JobState	UNKNOWN	ジョブの状態は不明です。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタ	説明
protected	JobState(int value)	指定された整数値を使用して新しいジョブ状態列挙値を構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
final Class<? extends Attribute>	getCategory()	この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
protected EnumSyntax[]	getEnumValueTable()	JobStateクラスの列挙値表を返します。
final 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の文字列表を返します。

オーバーライド:

getStringTable、クラスEnumSyntax

戻り値:

文字列テーブル

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()

JobStateクラスの列挙値表を返します。

オーバーライド:

getEnumValueTable、クラスEnumSyntax

戻り値:

値テーブル

getCategory

public final Class<? extends Attribute> getCategory()

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

クラスJobStateおよびベンダー定義のサブクラスの場合、カテゴリはクラスJobState自体です。

定義:

getCategory、インタフェースAttribute

戻り値:

印刷属性クラス(category)、クラスjava.lang.Classのインスタンス

getName

public final String getName()

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

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

定義:

getName、インタフェースAttribute

戻り値:

属性カテゴリ名