biz-Stream V5 サポート

biz-Stream V5 サポート

biz-Streamマニュアル›バッチ印刷ガイド›第3章 バッチ印刷アプリケーションの開発の概要›3.4 PDFBatchStatus、PDFBatchPrintStatusクラス

3.4 PDFBatchStatus、PDFBatchPrintStatusクラス

ここでは、印刷サーバから印刷状態を取得するPDFBatchStatusと、取得した印刷状態を格納するPDFBatchPrintStatusに関して説明します。


PDFBatchStatusクラス

PDFBatchStatusクラスは、印刷サーバから印刷状態を取得するクラスです。
PDFBatchStatusクラスでは、以下の情報を取得できます。

名称 説明
受付結果 印刷状態取得の受付結果を文字列で返します
　SUCCESS ： 印刷状態取得に成功
　FAIL ： 印刷状態取得に失敗
エラーコード 受付結果のステータスコードを3桁の文字列で返します (参照)
エラー原因 受付結果が「FAIL」のときのみ、エラーとなった原因の種別を文字列で返します
エラー内容 受付結果が「FAIL」のときのみ、エラーの詳細を文字列で返します
  • エラー原因とエラー内容は、受付結果がFAILの場合のみ返されます。



  1. コンストラクタ

    PDFBatchStatusが持つコンストラクタは次の一つのみです。引数に、印刷サーバのURLを指定します。ポート番号を指定することもできます。
    PDFBatchStatus(String URL)
    引数名 タイプ 説明
    URL String 印刷サーバのURL、または、印刷サーバのURL:ポート番号
    例) http://server/ または、http://server:3000/

  2. queryメソッド

    印刷サーバからすべてのジョブIDの印刷状態を取得します。
    void query()

    引数名 タイプ 説明
    なし ― ―

  3. queryメソッド

    印刷サーバから該当するジョブIDの印刷状態を取得します。
    void query(String jobID)

    引数名 タイプ 説明
    jobID String 印刷ジョブID

  4. setBatchStatusPortメソッド

    デフォルトの3000以外をポート番号として指定します。
    void setBatchStatusPort(String value)

    引数名 タイプ 説明
    value String 1024～65535までの整数値のみが指定できます。それ以外を指定した場合はデフォルトポートのままです。

  5. getPrintStatusメソッド

    ジョブの印刷状態を取得するため、PDFBatchPrintStatusクラスのインスタンスを取得します。
    String getResult()

    戻り値名 タイプ 説明
    getResult String PDFBatchPrintStatusクラスのインスタンス

  6. getResultメソッド

    印刷状態取得の受付結果を返します。
    String getResult()

    戻り値名 タイプ 説明
    getResult String 印刷状態取得の受付結果
    　SUCCESS： 印刷状態取得に成功
    　FAIL： 印刷状態取得に失敗

  7. getErrorCodeメソッド

    印刷状態取得時、受付結果のステータスコードを返します。
    String getErrorCode()

    戻り値名 タイプ 説明
    getErrorCode String 受付結果のエラーコード (3桁) (参照)

  8. getErrorCauseメソッド

    受付結果が「FAIL」のときのみ、エラーとなった原因の種別を返します。
    String getErrorCause()

    戻り値名 タイプ 説明
    getErrorCause String エラー原因の種別

  9. getErrorDetailsメソッド

    受付結果が「FAIL」のときのみ、エラーの詳細を返します。エラーの詳細を返します。
    String getErrorDetails()

    戻り値名 タイプ 説明
    getErrorDetails String エラーの詳細


PDFBatchPrintStatusクラス

PDFBatchPrintStatusは、印刷ジョブの印刷状態の結果を格納するクラスです。
PDFBatchPrintStatusクラスでは、以下の情報を取得できます。

名称 説明
ジョブ名 印刷指示で指定した印刷ジョブ名を返します
例） 給与明細、売上明細
ジョブID 状態を取得したジョブIDを返します
出力プリンタ名 印刷指示で指定したプリンタ名を返します
タイムスタンプ 印刷指示を受け付けた日時を返します
形式 yyyy/mm/dd HH:MM:SS (24時形式　ゼロサプレス表記)
印刷状態コード 印刷状態コードを返します
印刷状態内容 印刷状態の内容を文字列で返します
エラーコード 印刷状態のステータスコードを3桁の文字列で返します (参照)
エラー原因 エラーコードが「000」以外のときのみ、エラーとなった原因の種別を文字列で返します
DATA ： 印刷データのエラー
LIBRARY ： Acrobat ライブラリ関連のエラー
FILE ： ファイル保存関連のエラー
PRINT ： 印刷時のエラー
OTHER ： その他のエラー
エラー内容 エラーコードが「000」以外のときのみ、エラーの詳細を文字列で返します
  • エラー原因とエラー内容は、エラーコードが「000」以外の場合のみ返されます。



  1. getJobNameメソッド

    印刷指示で指定したジョブ名を返します。
    String getJobName()

    戻り値名 タイプ 説明
    getJobName String ジョブ名

  2. getPrinterNameメソッド

    印刷指示で指定したプリンタ名を返します。
    String getPrinterName()

    戻り値名 タイプ 説明
    getPrinterName String 印刷指示で指定したプリンタ名

  3. getDateTimeメソッド

    印刷指示を受け付けた日時を返します。
    String getDateTime()

    戻り値名 タイプ 説明
    getDateTime String 印刷指示を受け付けた日時

  4. getStatusCodeメソッド

    印刷状態コードを返します。
    String getStatusCode()

    戻り値名 タイプ 説明
    getStatusCode String 印刷状態コード
    印刷状態コード表
    コードは、プリンタによって取得できない場合があります。
    コード ステータス 説明
    000 印刷指示受信 印刷指示受信直後(作成時)状態です。
    002 印刷指示受付(印刷順待ち) 印刷キューに入り、印刷されるのを待っています。
    004 印刷中 印刷要求を処理中です。
    006 印刷要求送信完了(印刷終了) 印刷要求がプリンタスプーラに送信されました。
    008 印刷異常終了 印刷要求に対する処理が異常終了しました。
    016 印刷要求送信タイムアウト 印刷要求をプリンタスプーラに送信しようとしてタイムアウトになりました。

  5. getStatusメソッド

    印刷状態を示す文字列を返します。
    String getStatus()

    戻り値名 タイプ 説明
    getStatus String 印刷状態を示す文字列

  6. getErrorCodeメソッド

    印刷状態のエラーコードを返します。 (参照)
    String getErrorCode()

    戻り値名 タイプ 説明
    getErrorCode String 印刷状態のエラーコード (3桁) (参照)

  7. getErrorCauseメソッド

    エラーコードが「000」以外のときのみ、エラーとなった原因の種別を返します。
    String getErrorCause()

    戻り値名 タイプ 説明
    getErrorCause String エラー原因の種別

  8. getErrorDetailsメソッド

    エラーコードが「000」以外のときのみ、エラーの詳細を返します。
    String getErrorDetails()

    戻り値名 タイプ 説明
    getErrorDetails String エラーの詳細