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

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クラスのインスタンスを取得します。
   PDFBatchPrintStatus getPrintStatus(String jobId)

   引数名	タイプ	説明
   jobId	String	印刷状態を取得するJOBID

6. getPrintStatusメソッド

   引数を指定しない場合は、全てのジョブの印刷状態をPDFBatchPrintStatusのCollectionとして取得します。
   Collection getPrintStatus()

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

7. getResultメソッド

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

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

8. getErrorCodeメソッド

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

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

9. getErrorCauseメソッド

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

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

10. getErrorDetailsメソッド

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

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