8.2.2 メソッド一覧
EURPMAdapterForJavaクラスのメソッドには,帳票の出力や出力情報を採取するメソッド(実行メソッド)と,帳票を出力するために帳票ファイル名やデータファイル名などの情報を設定するメソッド(設定メソッド)があります。また,実行メソッドには,出力情報などを取得するメソッド(情報取得メソッド)と,帳票を出力するメソッド(出力メソッド)があります。実行メソッドを表8-2に示します。
種類 |
メソッド |
概要 |
---|---|---|
情報取得メソッド |
出力先(スプールサーバ)の一覧を取得します。 |
|
getJobIDメソッドを実行する直前に蓄積したスプールデータのジョブIDを取得します。 帳票を分割または仕分けして蓄積した場合など,直前に蓄積したスプールデータが複数あるときは,最初に蓄積したスプールデータのジョブIDを取得します。 |
||
getJobIDListメソッドを実行する直前に蓄積したスプールデータのジョブIDの一覧を取得します。 |
||
getOutputPageCountメソッドを実行する直前に印刷またはファイル出力を実行した帳票の総ページ数を取得します。 |
||
帳票サーバに登録されているプリンタクラスの一覧を取得します。 |
||
帳票サーバのOSに登録されているプリンタの一覧を取得します。 |
||
帳票サーバのOSに登録されているプリンタのトレイ一覧を取得します。 |
||
EUR Web Plug-In(プレビュー用)のクラスIDを取得します。 |
||
EUR Web Plug-In(プレビュー用)のバージョンを取得します。 |
||
EUR Web Plug-In(印刷用)のクラスIDを取得します。 |
||
EUR Web Plug-In(印刷用)のバージョンを取得します。 |
||
指定した出力先(スプールサーバ)に登録されているプリンタクラスの一覧を取得します。 |
||
指定した出力先(スプールサーバ)のOSに登録されているプリンタの一覧を取得します。 |
||
指定した出力先(スプールサーバ)のOSに登録されているプリンタのトレイ一覧を取得します。 |
||
出力メソッド |
EPF形式データをメモリに取得します。 |
|
EUR形式データをメモリに取得します。 |
||
複数のEPF形式ファイルを一つに統合してメモリに取得します。 |
||
PDF形式データをメモリに取得します。 |
||
Excel形式データをメモリに取得します。 |
||
EPF形式ファイルを出力します。 |
||
EUR形式ファイルを出力します。 |
||
複数のEPF形式ファイルを一つのEPF形式ファイルに統合して出力します。 |
||
PDF形式ファイルを出力します。 |
||
Excel形式ファイルを出力します。 |
||
帳票を印刷または蓄積します。 |
- 注※1
-
帳票サーバがUNIX/Linux環境の場合は指定できません。
- 注※2
-
対象となるスプールサーバがUNIX/Linux環境の場合は指定できません。
EURPMAdapterForJavaクラスのメソッドのうち,出力メソッドで使用する設定メソッドを表8-4に示します。表8-4では,出力メソッドを表8-3のように省略して表記します。
略称 |
出力メソッド |
---|---|
PMRS |
printReport(スプールサーバでの印刷) |
PMRC |
printReport(クライアントPCでの印刷) |
PMRT |
printReport(蓄積) |
PMRD |
printReport(直接印刷) |
PMRH |
printReport(クライアントPCへの配布印刷) |
|
outputPDFReport(PDF形式ファイル出力)または getPDFReport(PDF形式データ出力) |
EPF |
outputEPFReport(EPF形式ファイル出力)または getEPFReport(EPF形式データ出力) |
MEPF |
outputMergeEPFReport(複数EPF形式ファイル統合出力)または getMergeEPFReport(複数EPF形式ファイル統合データ出力) |
EUR |
outputEURReport(EUR形式ファイル出力)または getEURReport(EUR形式データ出力) |
XLSX |
outputXLSXReport(Excel形式ファイル出力)または getXLSXReport(Excel形式データ出力) |
メソッド |
設定内容 |
出力メソッド |
|||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PMRS |
PMRC |
PMRT |
PMRD |
PMRH |
|
EPF |
MEPF |
EUR |
XLSX |
||
EUR Server - Adapterで使用する環境設定ファイルのパス |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
|
しおり定義データ |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
しおり定義ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
文書しおり定義ファイルのパス,およびしおり定義ファイルのパス |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
クライアントPCのIPアドレス |
− |
△ |
△ |
− |
△ |
− |
− |
− |
− |
− |
|
印刷先クライアントプリンタ名 |
− |
△ |
△ |
− |
△ |
− |
− |
− |
− |
− |
|
印刷先クライアントプリンタのトレイ名 |
− |
△ |
△ |
− |
△ |
− |
− |
− |
− |
− |
|
PDF形式ファイルの暗号化出力の有無 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
暗号化設定データ |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
暗号化設定ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
暗号化設定ファイルのパス |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
マッピングデータまたは可変記号値定義データ |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
マッピングデータファイル名または可変記号値定義ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
マッピングデータファイルのパスまたは可変記号値定義ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
接続情報ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
接続情報ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
帳票の出力先名 |
△ |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
ダイアログ表示モード |
− |
△ |
△ |
− |
△ |
− |
− |
− |
− |
− |
|
PDF仕分け定義データ |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
PDF仕分け定義ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
PDF仕分け定義ファイルのパス |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
文書しおり定義データ |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
文書しおり定義ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
文書情報設定ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
文書情報設定ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
スプールデータに格納されているEPF形式ファイルの取得可否 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
パスワード暗号化鍵 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
メモリ取得したEPF形式ファイルデータ |
− |
− |
− |
− |
△※1 |
− |
− |
− |
− |
− |
|
EPF形式ファイル名 |
− |
− |
− |
− |
△※1 |
− |
○※2 |
○※2 |
− |
− |
|
EPF形式ファイルの出力フォルダ |
− |
− |
− |
− |
△ |
− |
△※2 |
△※2 |
− |
− |
|
出力するEUR形式ファイル名 |
− |
− |
− |
− |
− |
− |
− |
− |
○※3 |
− |
|
出力するEUR形式ファイルのパス |
− |
− |
− |
− |
− |
− |
− |
− |
△※3 |
− |
|
実行可能印刷方式 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
PDF形式ファイルの出力先マシン |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
ページ番号の初期値 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
− |
|
帳票振り分け定義の振り分けグループ名 |
△ |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
ページ番号の開始番号の初期化 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
− |
|
スプールデータとして格納するファイルの検索キーの分類 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールデータの検索キーの値 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールデータの上限印刷回数 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
統合対象のEPF形式ファイル名 |
− |
− |
− |
− |
− |
− |
− |
○ |
− |
− |
|
統合対象のEPF形式ファイルのパス |
− |
− |
− |
− |
− |
− |
− |
△ |
− |
− |
|
複数のしおり定義ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
複数のマッピングデータファイル名または可変記号値定義ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
複数様式情報定義ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
複数様式情報定義ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
複数の帳票ファイル名 |
△※4 |
△※4 |
△※4 |
△※4 |
− |
△※4 |
△※4 |
− |
△※4 |
− |
|
帳票セット指定ファイル名 |
△※4 |
△※4 |
△※4 |
△※4 |
− |
△※4 |
△※4 |
− |
△※4 |
− |
|
帳票セット指定ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
複数のユーザ定義データファイル名または可変記号値定義ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
− |
|
出力した帳票の総ページ数を出力するかどうか |
△※5 |
△ |
△ |
△ |
−※6 |
△ |
△ |
−※6 |
− |
△ |
|
ページ番号のフォーマット |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
− |
|
余白へのページ番号の印刷位置 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
− |
|
用紙の向き |
△ |
△ |
△ |
△ |
− |
− |
△ |
△ |
− |
− |
|
PDF形式ファイル名 |
− |
− |
− |
− |
− |
○※7, ※8 |
− |
− |
− |
− |
|
PDF形式ファイルのパス |
− |
− |
− |
− |
− |
△※8 |
− |
− |
− |
− |
|
帳票サーバのIPアドレス |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
|
帳票サーバのポート番号 |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
|
印刷部数 |
△ |
△ |
△ |
△ |
− |
− |
△ |
△ |
− |
− |
|
印刷日時出力定義ファイル名 |
△ |
△ |
△ |
− |
− |
− |
△ |
− |
− |
− |
|
印刷日時出力定義ファイルのパス |
△ |
△ |
△ |
− |
− |
− |
△ |
− |
− |
− |
|
印刷終了ページ |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
△ |
|
プリンタクラス名 |
△ |
△ |
△ |
△ |
− |
− |
△ |
△ |
− |
− |
|
プリンタ指定方式 |
△ |
− |
△ |
△※9 |
− |
− |
− |
− |
− |
− |
|
蓄積印刷方式で,蓄積後に続けて印刷するかどうか |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールサーバ印刷方式の印刷モード |
△ |
− |
− |
− |
− |
− |
− |
− |
− |
− |
|
印刷メソッド(printReportメソッド)の印刷方式 |
△ |
△ |
△ |
△ |
△ |
− |
− |
− |
− |
− |
|
余白へのページ番号印刷 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
− |
|
印刷開始ページ |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
− |
△ |
|
EUR Print Server Serviceの環境設定ファイル(EURPS_ENV)名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
EUR Print Serviceの環境設定ファイル(EURPS_ENV)のパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
置き換え表管理情報ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
置き換え表管理情報ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
宛先キーの分類 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
宛先キーの値 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
帳票ファイル名 |
△※4, ※10 |
△※4, ※10 |
△※4, ※10 |
△※4, ※10 |
− |
△※4, ※10 |
△※4, ※10 |
− |
△※4, ※10 |
△※4 |
|
帳票ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
帳票ID |
△※4 |
△※4 |
△※4 |
△※4 |
− |
△※4 |
△※4 |
− |
△※4 |
△※4 |
|
Acrobat JavaScript定義ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
Acrobat JavaScript定義ファイルのパス |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
スプールサーバのIPアドレス |
△ |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
サーバプリンタ名 |
△ |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールサーバの選択方法 |
△ |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
サーバプリンタのトレイ名 |
△ |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
印刷部数の単位 |
△ |
△ |
△ |
△ |
− |
− |
△ |
△ |
− |
− |
|
分割/仕分け定義データ |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
分割/仕分け定義ファイル名 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
分割/仕分け定義ファイルのパス |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
帳票を分割または仕分けするかどうか |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールデータに格納するファイルのファイル名 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールデータの蓄積期限日 |
− |
− |
△ |
− |
− |
− |
− |
− |
− |
− |
|
スプールタイトル |
△ |
△ |
△ |
△ |
− |
− |
△ |
△ |
△ |
− |
|
ユーザ定義データまたは可変記号値定義データ |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
ユーザ定義データファイル名または可変記号値定義ファイル名 |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
ユーザ定義データファイルのパスまたは可変記号値定義ファイルのパス |
△ |
△ |
△ |
△ |
− |
△ |
△ |
− |
△ |
△ |
|
ビューアプレファレンス定義ファイル名 |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
ビューアプレファレンス定義ファイルのパス |
− |
− |
− |
− |
− |
△ |
− |
− |
− |
− |
|
Excel形式ファイル名 |
− |
− |
− |
− |
− |
− |
− |
− |
− |
○※11 |
|
Excel形式ファイルのパス |
− |
− |
− |
− |
− |
− |
− |
− |
− |
△※11 |
- (凡例)
-
○:必ず指定します。
△:指定を省略できます。
−:指定できません。
- 注
-
指定できないメソッドを指定した場合は,その指定を無視します。
- 注※1
-
クライアントPCへの配布印刷の場合は,EPF形式ファイル名(setEPFFileNameメソッド)またはEPF形式ファイルデータ(setEPFFileDataメソッド)のどちらかを必ず指定してください。
- 注※2
-
EPF形式データ(getEPFReportメソッド)およびEPF形式データ(getMergeEPFReportメソッド)では指定できません。
- 注※3
-
EUR形式データ(getEURReportメソッド)では指定できません。
- 注※4
-
帳票セット指定ファイル名(setMultiReportSetFileNameメソッド),帳票ファイル名(setReportFileNameメソッド),または帳票ID(setReportIDメソッド)のどれかは,必ず指定してください。
- 注※5
-
印刷モードがEUR形式ファイル印刷モード(setPrintKind=1)の場合は,帳票の総ページ数を取得できません。setOutputPageCountOptメソッドを指定しても無視されます。
- 注※6
-
出力した帳票の総ページ数を取得できません。出力した帳票の総ページ数の情報が必要な場合は,次に示す運用としてください。
-
クライアントPCへの配布印刷
クライアントPCに配布する個々の印刷データ(EPF形式ファイル)を出力するときに帳票の総ページ数を取得し,合計ページ数は計算して求める運用としてください。
-
複数EPF形式ファイル統合出力
個々のEPF形式ファイルを出力するときに帳票の総ページ数を出力し,合計ページ数は計算して求める運用としてください。
-
- 注※7
-
PDF仕分け定義ファイル名(setDistributeFileNameメソッド)を指定している場合は,指定を省略できます。
- 注※8
-
PDF形式データ(getPDFReportメソッド)では指定できません。
- 注※9
-
指定できるプリンタ印刷方式は,「プリンタクラス名指定」または「OS上のプリンタ名指定」です。
- 注※10
-
帳票セット指定ファイル名(setMultiReportSetFileNameメソッド)を指定している場合は,指定を省略できます。
- 注※11
-
Excel形式データ(getXLSXReportメソッド)では指定できません。
- 重要
-
EUR Print Serviceと連携して使用するメソッドでエラーが発生した場合は,次のエラーメッセージが出力されます。メッセージが表示されたときは,EUR Print Serviceのイベントログ,またはeurpsログを参照してください。
メッセージID
メッセージ
KEEY221-E
印刷処理でエラーが発生しました。(337)
KEEY223-E
PDF形式ファイル出力処理でエラーが発生しました。(337)
KEEY225-E
EPF形式ファイル出力処理でエラーが発生しました。(337)
KEEY243-E
EUR形式ファイル出力処理でエラーが発生しました。(337)
KEEY263-E
XLSX形式ファイル出力処理でエラーが発生しました。(337)
EURPMAdapterForJavaクラスのメソッドのうち,情報取得メソッドで使用する設定メソッドを表8-6に示します。表8-6では,情報取得メソッドを表8-5のように省略して表記します。
略称 |
情報取得メソッド |
---|---|
GEDL |
getDestinationList(出力先一覧の取得) |
GEPC |
getPMPrinterClassList(帳票サーバのプリンタクラス一覧の取得) |
GEPP |
getPMPrinterList(帳票サーバのプリンタ一覧の取得) |
GEPT |
getPMTrayList(帳票サーバのトレイ一覧を取得) |
GECL |
getPrinterClassList(プリンタクラス一覧の取得) |
GEPL |
getPrinterList(プリンタ一覧の取得) |
GETL |
getTrayList(トレイ一覧の取得) |
メソッド |
設定内容 |
情報取得メソッド |
||||||
---|---|---|---|---|---|---|---|---|
GEDL |
GEPC |
GEPP |
GEPT |
GECL |
GEPL |
GETL |
||
EUR Server - Adapterで使用する環境設定ファイルのパス |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
|
出力先名を指定します。 |
− |
− |
− |
− |
△ |
△ |
△ |
|
帳票サーバのIPアドレスを指定します。 |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
|
帳票サーバのポート番号を指定します。 |
△ |
△ |
△ |
△ |
△ |
△ |
△ |
|
サーバのプリンタ名を指定します。 |
− |
− |
− |
○ |
− |
− |
○ |
- (凡例)
-
○:必ず指定します。
△:指定を省略できます。
−:指定できません。