biz-Stream v5

biz-Stream v5

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

バッチ印刷ガイド

3.4.1 PDFBatchPrintStreamクラス

ここでは、印刷データの生成を行うPDFBatchPrintStreamクラスに関して説明します。

PDFBatchPrintStreamクラス

PDFBatchPrintStreamは、バッチ印刷で使用する印刷データを生成するためのストリーム・クラスです。
PDFBatchPrintStreamは、biz-StreamライブラリのPDF生成エンジンの出力先として指定します。
印刷データを生成する際には、印刷の制御を行うために以下のものを設定できます。

名称 メソッド 引数種別 メソッド未指定時の挙動
プリンタ名 setPrinterName 文字列 null (クライアントのデフォルトプリンタ)
出力トレイ setSelectedTray 文字列 null (自動選択)
印刷部数 setNumberOfCopy 数値 1 (1部)
印刷ジョブ名 setJobName 文字列 「JobName_Default」がセットされる
開始ページ番号 setFromPage 数値 1 ※1
終了ページ番号 setToPage 数値 -1 ※2
パスワード指定(平文) setPassword 文字列 空文字
パスワード指定(エンコード済み) setPasswordWithEncoded 文字列 空文字
用紙サイズに合わせてページを拡大/縮小 setDoFit true/false false (実際のサイズ)
ポート番号 setBatchPrintPort 数値 3000
  • ※1PDFファイルのページ数の範囲外を指定した場合、1を指定したのと同じ挙動になります。
  • ※2既定値の「-1」を指定すると、最終ページまで印刷できます。
  • ※3「用紙サイズに合わせてページを拡大/縮小」はAdobe Acrobat Reader の印刷ダイアログの下記赤枠の設定に該当します。
印刷ダイアログ
  • 上記印刷ダイアログの「PDFのページサイズに合わせて用紙を選択(Z)」のチェックが外れている場合、指定したプリンタのデフォルト原稿サイズの用紙を使用します。PDFの実際のページサイズがB5でもプリンタのデフォルト原稿サイズがA4の場合は、A4用紙で印刷されます。詳細は「2.4.2 PDFのページサイズに合わせて用紙を選択する設定」を参照してください。

また、PDFBatchPrintStreamは、バッチ印刷の印刷指示に対する受付結果を取得できます。
以下がその内容です。

名称 メソッド 説明
受付結果 getResult 印刷指示の受付結果を文字列で返します
　SUCCESS： 印刷指示に成功
　FAIL： 印刷指示に失敗
エラーコード getErrorCode 受付結果のステータスコードを3桁の数字文字列で返します (参照)
エラー原因 getErrorCause 受付結果が「FAIL」のときのみ、エラーとなった原因の種別を文字列で返します
DATA : 印刷データのエラー
LIBRARY : Acrobat ライブラリ関連のエラー
FILE : ファイル保存関連のエラー
PRINT : 印刷時のエラー
OTHER : その他のエラー
エラー内容 getErrorDetails 受付結果が「FAIL」のときのみ、エラーの詳細を文字列で返します
印刷ジョブID getJobId 印刷サーバで自動作成され、印刷状態を取得する際のIDとして使用します。
IDは、印刷要求で指定されたジョブIDと要求受信時間を基にしたユニークな文字列となります
  • エラー原因とエラー内容は、受付結果がFAILの場合のみ返されます。

  1. コンストラクタ

    PDFBatchPrintStreamが持つコンストラクタは次の一つのみです。引数に、印刷サーバのURLを指定します。ポート番号を指定することもできます。
    PDFBatchPrintStream(String URL)

    引数名 タイプ 説明
    URL String 印刷サーバのURL、または、印刷サーバのURL:ポート番号
    例)http://server/、または、http://server:3000/

  2. setPrinterNameメソッド

    出力先のプリンタ名（「コントロールパネル」の「デバイスとプリンター」で表示されるプリンタ名）を指定します。
    void setPrinterName(String printerName)

    引数名 タイプ 説明
    printerName String 出力先のプリンタ名
    例) Canon LBP3800 LIPS

  3. setSelectedTrayメソッド

    印刷に使用するトレイを指定します。指定する値はあらかじめPDFBatchPrintStreamクラスに宣言されている下記の表の定数名を使用してください。
    void setSelectedTray(String selectedTray)

    引数名 タイプ 説明
    selectedTray String 出力トレイ※（下記の表を参照）
    出力トレイ指定用の定数名
    定数名 説明
    PDFBatchStream.TRAY_UPPER 上段のトレイ
    PDFBatchStream.TRAY_MIDDLE 中段のトレイ
    PDFBatchStream.TRAY_LOWER 下段のトレイ
    PDFBatchStream.TRAY_MANUAL 手差しトレイ
    PDFBatchStream.TRAY_AUTO 最適のトレイを自動選択
    • ※ 出力トレイの指定は、プリンタによって異なりますので、あらかじめプリンタの動作をご確認ください。

  4. setNumberOfCopyメソッド

    印刷する部数を正の整数で指定します。
    void setNumberOfCopy(int numberOfCopy)

    引数名 タイプ 説明
    numberOfCopy int 印刷部数（正の整数）

  5. setJobNameメソッド

    印刷のジョブ名称を任意の文字列で指定します。
    void setJobName(String jobName)

    引数名 タイプ 説明
    jobName String 印刷のジョブ名
    例） 給与明細
    • 印刷ジョブ名を指定した場合、出力先プリンタのジョブ一覧に表示されるジョブ名が v5 からは「C:\ProgramData\brainsellers\BatchPrint\tmp\印刷ジョブ名_年月日_時刻_連番.pdf」のようになります。ファイルパスは BatchPrintService.xml の「tmpFolderPath」に指定されているパスとなります。
    • OS のシステムロケールが UTF-8 以外の場合は印刷ジョブ名の日本語（全角や半角カナ）は文字化けします。
    例）以下をセットした場合
    ① String JobName = "JobNameTEST"
    ② String JobName = "ジョブ名テスト"
    印刷ジョブ名

  6. setFromPageメソッド

    印刷するファイルの開始ページ番号を指定します。
    void setFromPage(int fromPage)

    引数名 タイプ 説明
    fromPage int 印刷ファイルの開始ページ番号

  7. setToPageメソッド

    印刷するファイルの終了ページ番号を指定します。
    void setToPage(int toPage)

    引数名 タイプ 説明
    toPage int 印刷ファイルの終了ページ番号

  8. setPasswordメソッド

    ユーザパスワード(平文)をセットします。
    void setPassword(String value)

    引数名 タイプ 説明
    value String 平文パスワード

  9. setPasswordWithEncodedメソッド

    ユーザパスワード(base64エンコード済み)をセットします。
    void setPasswordWithEncoded(String value)

    引数名 タイプ 説明
    value String base64エンコード済みパスワード

  10. setDoFitメソッド

    用紙サイズに合わせて拡大縮小をするか実際のページサイズで印刷するかを選択します。
    void setDoFit(boolean value)

    引数名 タイプ 説明
    value boolean true : 現在選択されている用紙サイズの印刷可能領域に合わせて、各ページを縮小または拡大して印刷します。
    false : ページを拡大／縮小せずに実際のページサイズで印刷します。用紙に入りきらないページや領域は自動的にトリミングされます。

  11. setBatchPrintPortメソッド

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

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

  12. getResultメソッド

    印刷指示の受付結果を返します。
    String getResult()

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

  13. getErrorCodeメソッド

    印刷指示後、受付結果のステータスコードを返します。
    String getErrorCode()

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

  14. getErrorCauseメソッド

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

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

  15. getErrorDetailsメソッド

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

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

  16. getJobIdメソッド

    印刷指示後、ジョブIDを返します。
    String getJobId()

    戻り値名 タイプ 説明
    getJobId String ジョブID (ユニークな文字列)