javax.print.attribute.standard
クラス JobStateReason

java.lang.Object
  |
  +--javax.print.attribute.EnumSyntax
        |
        +--javax.print.attribute.standard.JobStateReason

すべての実装インタフェース:

Attribute, Cloneable, Serializable

public class JobStateReason

extends EnumSyntax

implements Attribute

JobStateReason はジョブの現在の状態についての追加情報、つまりジョブの JobState 属性をよりわかりやすくする情報を値の列挙として提供する印刷属性クラスです。JobStateReason クラスはジョブの状態理由を表す標準の値を定義します。印刷サービスを実装する場合、通知する必要があるジョブ状態理由は特定の実装に適応するものだけです。定義されているすべてのジョブ状態理由を通知する必要はありません。

JobStateReason 自体は印刷ジョブの属性セットでは直接使用されず、JobStateReasons 属性が使用されます。JobStateReasons 属性には、印刷ジョブのステータスに関連する JobStateReason オブジェクトがまったく含まれない場合もあり、1 つ以上含まれる場合もあります。プリンタは印刷ジョブの JobStateReasons オブジェクトに対応する条件が true になった時に、JobStateReason オブジェクトを印刷ジョブの JobStateReasons 属性に追加し、false になった時にこのオブジェクトを削除します。印刷ジョブ全体の JobState の変更とは無関係にこの処理が行われます。

IPP 互換性: getName() で返されるカテゴリ名が IPP 属性名、列挙される整数値が IPP の値、toString() メソッドが返す値が属性値の IPP 文字列表現にそれぞれ対応します。

関連項目:

直列化された形式

フィールドの概要

static JobStateReason	ABORTED_BY_SYSTEM ジョブがシステム側で中止されました。
static JobStateReason	COMPRESSION_ERROR ドキュメントデータの圧縮解除中にプリンタがエラーを検出したため、ジョブがシステム側で中止されました。
static JobStateReason	DOCUMENT_ACCESS_ERROR 参照で渡されたドキュメント、つまり URL として表された印刷データオブジェクトにアクセスできませんでした。
static JobStateReason	DOCUMENT_FORMAT_ERROR ドキュメントデータの処理中にプリンタがエラーを検出したため、ジョブがシステム側で中止されました。
static JobStateReason	JOB_CANCELED_AT_DEVICE ジョブが未確認のローカルユーザ、つまりデバイスのコンソールからログインしたユーザによって取り消されました。
static JobStateReason	JOB_CANCELED_BY_OPERATOR ジョブは operator、つまりローカルまたはリモートのどちらかで operator 権限を持つユーザによって取り消されました。
static JobStateReason	JOB_CANCELED_BY_USER ジョブは所有者、つまり認証 ID が印刷ジョブを生成した発生元のユーザと一致するユーザ、またはジョブ所有者のセキュリティグループのメンバなどの、一定の権限を持つエンドユーザによって取り消されました。
static JobStateReason	JOB_COMPLETED_SUCCESSFULLY ジョブが正常に完了しました。
static JobStateReason	JOB_COMPLETED_WITH_ERRORS ジョブは完了していますがエラーが (そしておそらく警告も) 出されています。
static JobStateReason	JOB_COMPLETED_WITH_WARNINGS ジョブは完了していますが警告が出されています。
static JobStateReason	JOB_DATA_INSUFFICIENT プリンタ上に印刷ジョブが生成されていますが、ジョブの状態を PROCESSING に変更するためには、さらに印刷データが必要です。
static JobStateReason	JOB_HOLD_UNTIL_SPECIFIED ジョブの JobHoldUntil 属性が未来の日付および時刻で指定されました。
static JobStateReason	JOB_INCOMING プリンタ上に印刷ジョブが生成されていますが、すべての印刷データへのアクセス、またはすべての印刷データの受け取りが終了していません。
static JobStateReason	JOB_INTERPRETING ジョブの状態は PROCESSING であり、より具体的にはプリンタがドキュメントデータを解釈中です。
static JobStateReason	JOB_OUTGOING プリンタがジョブを出力デバイスに転送しています。
static JobStateReason	JOB_PRINTING 出力デバイスが媒体をマーキングしています。
static JobStateReason	JOB_QUEUED ジョブの状態は PROCESSING であり、より具体的にはプリンタがドキュメントデータをキューに送信中です。
static JobStateReason	JOB_QUEUED_FOR_MARKER ジョブの状態が PENDING_HELD、PENDING、または PROCESSING のどれかであり、より具体的には、ドキュメントに対してマーキングのために充分な処理がプリンタで完了し、ジョブがマーカーを待っている状態です。
static JobStateReason	JOB_RESTARTABLE このジョブは削除されずに残っており、現在再開が可能です。
static JobStateReason	JOB_TRANSFORMING ジョブの状態は PROCESSING であり、より具体的にはプリンタがドキュメントデータを解釈し、別の形態の電子情報を生成中です。
static JobStateReason	PRINTER_STOPPED プリンタの PrinterState 属性の値が STOPPED です。
static JobStateReason	PRINTER_STOPPED_PARTLY プリンタの PrinterStateReasons 属性の値に STOPPED_PARTLY の PrinterStateReason 値が格納されています。
static JobStateReason	PROCESSING_TO_STOP_POINT 要求側がジョブを取り消したか、またはプリンタがジョブを中止しましたが、指定された停止ポイントに到達するまで、またはジョブの終了およびクリーンアップが完了するまで、プリンタ側で何らかのアクションが実行されています。
static JobStateReason	QUEUED_IN_DEVICE ジョブがステータスを返すことのできないデバイスまたは印刷システムに転送されました。
static JobStateReason	RESOURCES_ARE_NOT_READY 媒体、フォント、リソースオブジェクトなどの、ジョブが必要とするリソースの少なくとも 1 つが、ジョブが印刷される予定になっているプリンタ上で準備できていません。
static JobStateReason	SERVICE_OFF_LINE プリンタがオフラインであり、ジョブを受け付けません。
static JobStateReason	SUBMISSION_INTERRUPTED ジョブが何らかの予期しないエラーで完全に送信されませんでした。
static JobStateReason	UNSUPPORTED_COMPRESSION ドキュメントデータの圧縮解除中に、圧縮形式がプリンタでサポートされていないものであると判定されたため、ジョブが中止されました。
static JobStateReason	UNSUPPORTED_DOCUMENT_FORMAT ドキュメントデータの形式 (doc flavor) をプリンタがサポートしていないため、ジョブはシステム側で中止されました。

コンストラクタの概要

protected

JobStateReason(int value) 指定された整数値を使用して新しいジョブ状態理由列挙値を構築します。

メソッドの概要

Class	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
protected EnumSyntax[]	getEnumValueTable() JobStateReason クラスの列挙値テーブルを返します。
String	getName() この属性値がインスタンスであるカテゴリの名称を返します。
protected String[]	getStringTable() JobStateReason クラスの文字列テーブルを返します。

クラス javax.print.attribute.EnumSyntax から継承したメソッド

clone, getOffset, getValue, hashCode, readResolve, toString

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

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

フィールドの詳細

JOB_INCOMING

public static final JobStateReason JOB_INCOMING

プリンタ上に印刷ジョブが生成されていますが、すべての印刷データへのアクセス、またはすべての印刷データの受け取りが終了していません。

JOB_DATA_INSUFFICIENT

public static final JobStateReason JOB_DATA_INSUFFICIENT

プリンタ上に印刷ジョブが生成されていますが、ジョブの状態を PROCESSING に変更するためには、さらに印刷データが必要です。すべてのデータを受信する前にプリンタが処理を開始すると、JOB_DATA_INSUFFICIENT 理由は削除されますが、JOB_INCOMING 理由は残ります。すべてのデータを受信した後でプリンタが処理を開始すると、JOB_DATA_INSUFFICIENT 理由と JOB_INCOMING 理由が同時に削除されます。

DOCUMENT_ACCESS_ERROR

public static final JobStateReason DOCUMENT_ACCESS_ERROR

参照で渡されたドキュメント、つまり URL として表された印刷データオブジェクトにアクセスできませんでした。この理由は、ファイルが存在しない、あるいはアクセス制御の問題でアクセスが拒否されたなどの、ファイルアクセスに関するすべての問題に対応するためのものです。プリンタ側でジョブを中断し、ジョブの状態を ABORTED に変更する場合と、アクセス可能なドキュメントをすべて印刷し、ジョブの状態を COMPLETED に変更し、JobStateReasons 属性に COMPLETED_WITH_ERRORS 理由を追加する場合があります。どちらになるかは実装のポリシーまたはサイトのポリシー、あるいはその両方で決定されます。URL として表される印刷データオブジェクトを持つドキュメントフレーバをプリンタがサポートする場合、この値がサポートされている必要があります。

SUBMISSION_INTERRUPTED

public static final JobStateReason SUBMISSION_INTERRUPTED

ジョブが何らかの予期しないエラーで完全に送信されませんでした。理由として考えられるのは、(1) ジョブがクライアントから完全に送信される前にプリンタがクラッシュした、(2) ドキュメントデータが完全にプリンタに転送される前に、プリンタまたはドキュメント転送メソッドで回復不可能な障害が発生した、(3) ジョブが完全に送信される前にクライアントがクラッシュした、などです。

JOB_OUTGOING

public static final JobStateReason JOB_OUTGOING

プリンタがジョブを出力デバイスに転送しています。

JOB_HOLD_UNTIL_SPECIFIED

public static final JobStateReason JOB_HOLD_UNTIL_SPECIFIED

ジョブの JobHoldUntil 属性が未来の日付および時刻で指定されました。この指定を変更するまでジョブは処理対象になりません。またジョブが保持されている理由はこれだけです。JobHoldUntil ジョブテンプレート属性がサポートされている場合にこの値がサポートされている必要があります。

RESOURCES_ARE_NOT_READY

public static final JobStateReason RESOURCES_ARE_NOT_READY

媒体、フォント、リソースオブジェクトなどの、ジョブが必要とするリソースの少なくとも 1 つが、ジョブが印刷される予定になっているプリンタ上で準備できていません。この状態がいつ検出されるかは実装によって異なり、ジョブの状態が ACCEPTED、またはその後の PENDING あるいは PROCESSING の場合です。ジョブの状態は変わらない場合もあり、PENDING_HELD に変わる場合もあります。これは実装またはジョブスケジューリングポリシー、あるいはその両方で決定されます。

PRINTER_STOPPED_PARTLY

public static final JobStateReason PRINTER_STOPPED_PARTLY

プリンタの PrinterStateReasons 属性の値に STOPPED_PARTLY の PrinterStateReason 値が格納されています。

PRINTER_STOPPED

public static final JobStateReason PRINTER_STOPPED

プリンタの PrinterState 属性の値が STOPPED です。

JOB_INTERPRETING

public static final JobStateReason JOB_INTERPRETING

ジョブの状態は PROCESSING であり、より具体的にはプリンタがドキュメントデータを解釈中です。

JOB_QUEUED

public static final JobStateReason JOB_QUEUED

ジョブの状態は PROCESSING であり、より具体的にはプリンタがドキュメントデータをキューに送信中です。

JOB_TRANSFORMING

public static final JobStateReason JOB_TRANSFORMING

ジョブの状態は PROCESSING であり、より具体的にはプリンタがドキュメントデータを解釈し、別の形態の電子情報を生成中です。

JOB_QUEUED_FOR_MARKER

public static final JobStateReason JOB_QUEUED_FOR_MARKER

ジョブの状態が PENDING_HELD、PENDING、または PROCESSING のどれかであり、より具体的には、ドキュメントに対してマーキングのために充分な処理がプリンタで完了し、ジョブがマーカーを待っている状態です。人間の手でジョブをリリースする必要があるシステムでは、ジョブの状態は PENDING_HELD になります。ジョブを自動的に選択してマーカーを使うシステムでは、ジョブの状態は実装によって異なり、PENDING になるか、PROCESSING のままになります。マーキングが実際に開始されると、ジョブの状態はどの実装でも PROCESSING になります。

JOB_PRINTING

public static final JobStateReason JOB_PRINTING

出力デバイスが媒体をマーキングしています。この値は (1) マーキングが実際に行われていなくても、あたかも行われているように見せる時、または (2) ジョブの取り消しまたは中断時に、ジョブが PROCESSING のままで残り、マーキングが停止されず、印刷データまたはページカウントが増大し続けている時に、処理時間が非常に長くなるプリンタに対して有効です。

JOB_CANCELED_BY_USER

public static final JobStateReason JOB_CANCELED_BY_USER

ジョブは所有者、つまり認証 ID が印刷ジョブを生成した発生元のユーザと一致するユーザ、またはジョブ所有者のセキュリティグループのメンバなどの、一定の権限を持つエンドユーザによって取り消されました。この値は必ずサポートする必要があります。

JOB_CANCELED_BY_OPERATOR

public static final JobStateReason JOB_CANCELED_BY_OPERATOR

ジョブは operator、つまりローカルまたはリモートのどちらかで operator 権限を持つユーザによって取り消されました。セキュリティポリシーですべてのユーザがすべてのユーザのジョブを取り消し可能になっている場合は、ジョブがその所有者以外のユーザによって削除された場合に、この値を使用できます。このようなセキュリティポリシーの元では、事実上すべてのユーザがジョブの取り消しに関して operator 権限を持つことになります。ジョブの所有者以外のユーザによるジョブの取り消しが実装で許可されている場合は、この値をサポートする必要があります。

JOB_CANCELED_AT_DEVICE

public static final JobStateReason JOB_CANCELED_AT_DEVICE

ジョブが未確認のローカルユーザ、つまりデバイスのコンソールからログインしたユーザによって取り消されました。この値はコンソールからのジョブ取り消しが実装でサポートされている場合にサポートする必要があります。

ABORTED_BY_SYSTEM

public static final JobStateReason ABORTED_BY_SYSTEM

ジョブがシステム側で中止されました。ジョブは (1) 中止処理中であるか、(2) システム側で中止され、状態が ABORTED に変更されたか、または (3) システム側で中止され、ユーザまたは operator がマニュアルでジョブを再開できるように、状態が PENDING_HELD に変更されるかのどれかです。この値は必ずサポートする必要があります。

UNSUPPORTED_COMPRESSION

public static final JobStateReason UNSUPPORTED_COMPRESSION

ドキュメントデータの圧縮解除中に、圧縮形式がプリンタでサポートされていないものであると判定されたため、ジョブが中止されました。Compression は必須ドキュメント記述属性であるため、この値は必ずサポートする必要があります。

COMPRESSION_ERROR

public static final JobStateReason COMPRESSION_ERROR

ドキュメントデータの圧縮解除中にプリンタがエラーを検出したため、ジョブがシステム側で中止されました。プリンタがこの理由を送信する場合、このドキュメントデータはジョブ状態理由 UNSUPPORTED_COMPRESSION を返すようなテストをすべて通過してきています。

UNSUPPORTED_DOCUMENT_FORMAT

public static final JobStateReason UNSUPPORTED_DOCUMENT_FORMAT

ドキュメントデータの形式 (doc flavor) をプリンタがサポートしていないため、ジョブはシステム側で中止されました。MIME タイプが "application/octet-stream" のドキュメントフレーバをクライアントが指定している場合、ドキュメントデータの実際の形式をプリンタが自動検知できなければ、たとえ明示的に指定されていればサポートしている形式でも、ジョブは中止されます。ドキュメントフレーバは各ドキュメントに必ず指定する必要があるため、この値はサポートする必要があります。

DOCUMENT_FORMAT_ERROR

public static final JobStateReason DOCUMENT_FORMAT_ERROR

ドキュメントデータの処理中にプリンタがエラーを検出したため、ジョブがシステム側で中止されました。プリンタがこの理由を送信する場合、このドキュメントデータはジョブ状態理由 UNSUPPORTED_DOCUMENT_FORMAT を返すようなテストをすべて通過してきています。

PROCESSING_TO_STOP_POINT

public static final JobStateReason PROCESSING_TO_STOP_POINT

要求側がジョブを取り消したか、またはプリンタがジョブを中止しましたが、指定された停止ポイントに到達するまで、またはジョブの終了およびクリーンアップが完了するまで、プリンタ側で何らかのアクションが実行されています。

状態が PROCESSING または PROCESSING_STOPPED のジョブを取り消すために一定の時間が要求される実装形態の場合は、プリンタはこの理由を使用して、ジョブの状態が PROCESSING または PROCESSING_STOPPED の間に何らかのアクションを実行することを示します。すべてのジョブのジョブ記述属性の増加が停止した後で、ジョブの状態が PROCESSING から CANCELED または ABORTED に変更されます。

SERVICE_OFF_LINE

public static final JobStateReason SERVICE_OFF_LINE

プリンタがオフラインであり、ジョブを受け付けません。PENDING のジョブの状態がすべて PENDING_HELD に変更されます。サービスまたはドキュメント変換の入力機能が完全に動作していない場合、または故障している場合がこれに該当します。

JOB_COMPLETED_SUCCESSFULLY

public static final JobStateReason JOB_COMPLETED_SUCCESSFULLY

ジョブが正常に完了しました。この値はサポートする必要があります。

JOB_COMPLETED_WITH_WARNINGS

public static final JobStateReason JOB_COMPLETED_WITH_WARNINGS

ジョブは完了していますが警告が出されています。警告が検出される実装の場合はこの値をサポートする必要があります。

JOB_COMPLETED_WITH_ERRORS

public static final JobStateReason JOB_COMPLETED_WITH_ERRORS

ジョブは完了していますがエラーが (そしておそらく警告も) 出されています。エラーが検出される実装の場合はこの値をサポートする必要があります。

JOB_RESTARTABLE

public static final JobStateReason JOB_RESTARTABLE

このジョブは削除されずに残っており、現在再開が可能です。JOB_RESTARTABLE がジョブの JobStateReasons 属性に含まれる場合、プリンタはこのジョブの再開要求を受け入れる必要があります。ジョブの再開がサポートされている場合はこの値をサポートする必要があります。[ジョブの再開機能は Java の印刷サービス API には現在は用意されていません。]

QUEUED_IN_DEVICE

public static final JobStateReason QUEUED_IN_DEVICE

ジョブがステータスを返すことのできないデバイスまたは印刷システムに転送されました。プリンタはジョブの JobState 属性を COMPLETED に設定し、プリンタがジョブの追加情報を持たず、これ以上詳しい情報が得られないことを示すために QUEUED_IN_DEVICE 理由をジョブの JobStateReasons 属性に設定します。

コンストラクタの詳細

JobStateReason

protected JobStateReason(int value)

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

パラメータ:

value - 整数値

メソッドの詳細

getStringTable

protected String[] getStringTable()

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

オーバーライド:

クラス EnumSyntax 内の getStringTable

戻り値:

文字列テーブル

getEnumValueTable

protected EnumSyntax[] getEnumValueTable()

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

オーバーライド:

クラス EnumSyntax 内の getEnumValueTable

戻り値:

値テーブル

getCategory

public final Class getCategory()

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

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

この属性値がインスタンスであるカテゴリの名称を返します。

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

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリ名