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
属性はジョブが処理を停止している原因を示します。 たとえば、出力デバイスが停止している場合、ジョブJobStateReasons
属性にPRINTER_STOPPED
値が含まれている可能性があります。注: 出力デバイスが停止しているときは、近くにいる人が認識できるような形で、そのデバイス自体が状態を表します。 クライアントからプリンタの
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
この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。クラス
JobState
およびベンダー定義のサブクラスの場合、カテゴリはクラスJobState
自体です。- 定義:
getCategory
、インタフェース:Attribute
- 戻り値:
- 印刷属性クラス(category)、クラス
java.lang.Class
のインスタンス
-
getName
public final String getName()属性値がインスタンスとなるカテゴリの名前を返します。クラス
JobState
およびベンダー定義のサブクラスでは、カテゴリ名は"job-state"
です。
-