Hitachi

EUR 帳票出力 リファレンス EUR Server編


8.2.2 メソッド一覧

EURPMAdapterForJavaクラスのメソッドには,帳票の出力や出力情報を採取するメソッド(実行メソッド)と,帳票を出力するために帳票ファイル名やデータファイル名などの情報を設定するメソッド(設定メソッド)があります。また,実行メソッドには,出力情報などを取得するメソッド(情報取得メソッド)と,帳票を出力するメソッド(出力メソッド)があります。実行メソッドを表8-2に示します。

表8‒2 EURPMAdapterForJavaクラスの実行メソッド

種類

メソッド

概要

情報取得メソッド

getDestinationList

出力先(スプールサーバ)の一覧を取得します。

getJobID

getJobIDメソッドを実行する直前に蓄積したスプールデータのジョブIDを取得します。

帳票を分割または仕分けして蓄積した場合など,直前に蓄積したスプールデータが複数あるときは,最初に蓄積したスプールデータのジョブIDを取得します。

getJobIDList

getJobIDListメソッドを実行する直前に蓄積したスプールデータのジョブIDの一覧を取得します。

getOutputPageCount

getOutputPageCountメソッドを実行する直前に印刷またはファイル出力を実行した帳票の総ページ数を取得します。

getPMPrinterClassList

帳票サーバに登録されているプリンタクラスの一覧を取得します。

getPMPrinterList※1

帳票サーバのOSに登録されているプリンタの一覧を取得します。

getPMTrayList※1

帳票サーバのOSに登録されているプリンタのトレイ一覧を取得します。

getPreviewAXClassID

EUR Web Plug-In(プレビュー用)のクラスIDを取得します。

getPreviewAXVersion

EUR Web Plug-In(プレビュー用)のバージョンを取得します。

getPrintAXClassID

EUR Web Plug-In(印刷用)のクラスIDを取得します。

getPrintAXVersion

EUR Web Plug-In(印刷用)のバージョンを取得します。

getPrinterClassList※2

指定した出力先(スプールサーバ)に登録されているプリンタクラスの一覧を取得します。

getPrinterList※2

指定した出力先(スプールサーバ)のOSに登録されているプリンタの一覧を取得します。

getTrayList※2

指定した出力先(スプールサーバ)のOSに登録されているプリンタのトレイ一覧を取得します。

出力メソッド

getEPFReport

EPF形式データをメモリに取得します。

getEURReport

EUR形式データをメモリに取得します。

getMergeEPFReport

複数のEPF形式ファイルを一つに統合してメモリに取得します。

getPDFReport

PDF形式データをメモリに取得します。

getXLSXReport

Excel形式データをメモリに取得します。

outputEPFReport

EPF形式ファイルを出力します。

outputEURReport

EUR形式ファイルを出力します。

outputMergeEPFReport

複数のEPF形式ファイルを一つのEPF形式ファイルに統合して出力します。

outputPDFReport

PDF形式ファイルを出力します。

outputXLSXReport

Excel形式ファイルを出力します。

printReport

帳票を印刷または蓄積します。

注※1

帳票サーバがUNIX/Linux環境の場合は指定できません。

注※2

対象となるスプールサーバがUNIX/Linux環境の場合は指定できません。

EURPMAdapterForJavaクラスのメソッドのうち,出力メソッドで使用する設定メソッドを表8-4に示します。表8-4では,出力メソッドを表8-3のように省略して表記します。

表8‒3 出力メソッドの略称

略称

出力メソッド

PMRS

printReport(スプールサーバでの印刷)

PMRC

printReport(クライアントPCでの印刷)

PMRT

printReport(蓄積)

PMRD

printReport(直接印刷)

PMRH

printReport(クライアントPCへの配布印刷)

PDF

outputPDFReport(PDF形式ファイル出力)または

getPDFReport(PDF形式データ出力)

EPF

outputEPFReport(EPF形式ファイル出力)または

getEPFReport(EPF形式データ出力)

MEPF

outputMergeEPFReport(複数EPF形式ファイル統合出力)または

getMergeEPFReport(複数EPF形式ファイル統合データ出力)

EUR

outputEURReport(EUR形式ファイル出力)または

getEURReport(EUR形式データ出力)

XLSX

outputXLSXReport(Excel形式ファイル出力)または

getXLSXReport(Excel形式データ出力)

表8‒4  EURPMAdapterForJavaクラスの出力メソッドで使用する設定メソッド

メソッド

設定内容

出力メソッド

PMRS

PMRC

PMRT

PMRD

PMRH

PDF

EPF

MEPF

EUR

XLSX

setAdpEnvFile

EUR Server - Adapterで使用する環境設定ファイルのパス

setBookmarkFileData

しおり定義データ

setBookmarkFileName

しおり定義ファイル名

setBookmarkFilePath

文書しおり定義ファイルのパス,およびしおり定義ファイルのパス

setClientAddress

クライアントPCのIPアドレス

setClientPrinterName

印刷先クライアントプリンタ名

setClientTrayName

印刷先クライアントプリンタのトレイ名

setCrypto

PDF形式ファイルの暗号化出力の有無

setCryptoFileData

暗号化設定データ

setCryptoFileName

暗号化設定ファイル名

setCryptoFilePath

暗号化設定ファイルのパス

setDataFileData

マッピングデータまたは可変記号値定義データ

setDataFileName

マッピングデータファイル名または可変記号値定義ファイル名

setDataFilePath

マッピングデータファイルのパスまたは可変記号値定義ファイルのパス

setDBInfoFileName

接続情報ファイル名

setDBInfoFilePath

接続情報ファイルのパス

setDestinationName

帳票の出力先名

setDispPrintDlg

ダイアログ表示モード

setDistributeFileData

PDF仕分け定義データ

setDistributeFileName

PDF仕分け定義ファイル名

※1

setDistributeFilePath

PDF仕分け定義ファイルのパス

setDocBookmarkFileData

文書しおり定義データ

setDocBookmarkFileName

文書しおり定義ファイル名

setDocInfoFileName

文書情報設定ファイル名

setDocInfoFilePath

文書情報設定ファイルのパス

setEnableGet

スプールデータに格納されているEPF形式ファイルの取得可否

setEncryptionFileKey※16

ファイル暗号化鍵

setEncryptionPasswordKey

パスワード暗号化鍵

setEPFFileData

メモリ取得したEPF形式ファイルデータ

※2

setEPFFileName

EPF形式ファイル名

※2

※3

※3

setEPFFilePath

EPF形式ファイルの出力フォルダ

※3

※3

setEURFileName

出力するEUR形式ファイル名

※4

setEURFilePath

出力するEUR形式ファイルのパス

※4

setExecutablePrintMode

実行可能印刷方式

setFileOutputDestination

PDF形式ファイルの出力先マシン

※9

setFirstPageNumber

ページ番号の初期値

setGroupName

帳票振り分け定義の振り分けグループ名

setInitPageNumber

ページ番号の開始番号の初期化

setJobKeyCategory

スプールデータとして格納するファイルの検索キーの分類

setJobKeyData

スプールデータの検索キーの値

setMaxPrintCount

スプールデータの上限印刷回数

setMergeEPFFileName

統合対象のEPF形式ファイル名

setMergeEPFFilePath

統合対象のEPF形式ファイルのパス

setMultiBookmarkFileName

複数のしおり定義ファイル名

setMultiDataFileName

複数のマッピングデータファイル名または可変記号値定義ファイル名

setMultiFormInfoDefFileName

複数様式情報定義ファイル名

setMultiFormInfoDefFilePath

複数様式情報定義ファイルのパス

setMultiReportFileName

複数の帳票ファイル名

※5

※5

※5

※5

※5

※5

※5

setMultiReportSetFileName

帳票セット指定ファイル名

※5

※5

※5

※5

※5

※5

※5

setMultiReportSetFilePath

帳票セット指定ファイルのパス

setMultiUserDataFileName

複数のユーザ定義データファイル名または可変記号値定義ファイル名

setOutputPageCountOpt

出力した帳票の総ページ数を出力するかどうか

※6

※7

※7

setOutputSplitFileName

分割ファイル名

※1, ※8

setPageNumberFormat

ページ番号のフォーマット

setPageNumberLocation

余白へのページ番号の印刷位置

setPaperOrientation

用紙の向き

setPDFFileName

PDF形式ファイル名

※9, ※10

setPDFFilePath

PDF形式ファイルのパス

※10

setPMServerAddress

帳票サーバのIPアドレス

setPMServerPort

帳票サーバのポート番号

setPrintCopies

印刷部数

setPrintDateFileName

印刷日時出力定義ファイル名

setPrintDateFilePath

印刷日時出力定義ファイルのパス

setPrintEndPage

印刷終了ページ

setPrinterClassName

プリンタクラス名

setPrinterSelectMode

プリンタ指定方式

※11

setPrintHoldMode

蓄積印刷方式で,蓄積後に続けて印刷するかどうか

setPrintKind

スプールサーバ印刷方式の印刷モード

setPrintMode

印刷メソッド(printReportメソッド)の印刷方式

setPrintNewPaperFileName

新規用紙出力定義ファイル名

※6, ※12

※12

※12

※12

※12

※12

setPrintNewPaperFilePath

新規用紙出力定義ファイルのパス

※6, ※12

※12

※12

※12

※12

※12

setPrintPageNumber

余白へのページ番号印刷

setPrintStartPage

印刷開始ページ

setPSEnvFileName

EUR Print Serviceの環境設定ファイル(EURPS_ENV)名

setPSEnvFilePath

EUR Print Serviceの環境設定ファイル(EURPS_ENV)のパス

setReplaceItemCntlFileName

置き換え表管理情報ファイル名

※6

setReplaceItemCntlFilePath

置き換え表管理情報ファイルのパス

※6

setReportAddressKeyCategory

宛先キーの分類

setReportAddressKeyData

宛先キーの値

setReportFileName

帳票ファイル名

※5, ※13

※5, ※13

※5, ※13

※5, ※13

※5, ※13

※5, ※13

※5, ※13

※5

setReportFilePath

帳票ファイルのパス

setReportID

帳票ID

※5

※5

※5

※5

※5

※5

※5

※5

setScriptCntlFileName

Acrobat JavaScript定義ファイル名

setScriptCntlFilePath

Acrobat JavaScript定義ファイルのパス

setServerAddress

スプールサーバのIPアドレス

setServerPrinterName

サーバプリンタ名

setServerSelectMode

スプールサーバの選択方法

setServerTrayName

サーバプリンタのトレイ名

setSortPrint

印刷部数の単位

setSplitFileData

分割/仕分け定義データ

setSplitFileName

分割/仕分け定義ファイル名

setSplitFilePath

分割/仕分け定義ファイルのパス

setSplitMode

帳票を分割または仕分けするかどうか

setSplitPageNumber

分割ページ数

※1, ※8

setSplitResultFileName

分割結果ファイル名

※14

setSplitResultFilePath

分割結果ファイルのパス

※14

setSpoolFileName

スプールデータに格納するファイルのファイル名

setSpoolLimit

スプールデータの蓄積期限日

setSpoolTitle

スプールタイトル

setUserDataFileData

ユーザ定義データまたは可変記号値定義データ

setUserDataFileName

ユーザ定義データファイル名または可変記号値定義ファイル名

setUserDataFilePath

ユーザ定義データファイルのパスまたは可変記号値定義ファイルのパス

setViewerPreferenceFileName

ビューアプレファレンス定義ファイル名

setViewerPreferenceFilePath

ビューアプレファレンス定義ファイルのパス

setXLSXFileName

Excel形式ファイル名

※15

setXLSXFilePath

Excel形式ファイルのパス

※15

(凡例)

○:必ず指定します。

△:指定を省略できます。

−:指定できません。

指定できないメソッドを指定した場合は,その指定を無視します。

注※1

次に示すメソッドは同時に指定できません。同時に指定した場合はエラー(KEEY280-E)になります。

  • PDF仕分け定義ファイル名(setDistributeFileNameメソッド)

  • 分割ページ数(setSplitPageNumberメソッド)と分割ファイル名(setOutputSplitFileNameメソッド)

注※2

クライアントPCへの配布印刷の場合は,EPF形式ファイル名(setEPFFileNameメソッド)またはEPF形式ファイルデータ(setEPFFileDataメソッド)のどちらかを必ず指定してください。

注※3

EPF形式データ(getEPFReportメソッド)およびEPF形式データ(getMergeEPFReportメソッド)では指定できません。

注※4

EUR形式データ(getEURReportメソッド)では指定できません。

注※5

帳票セット指定ファイル名(setMultiReportSetFileNameメソッド),帳票ファイル名(setReportFileNameメソッド),または帳票ID(setReportIDメソッド)のどれかは,必ず指定してください。

注※6

印刷モードがEUR形式ファイル印刷モード(setPrintKind=1)の場合は,指定しても無視されます。

注※7

出力した帳票の総ページ数を取得できません。出力した帳票の総ページ数の情報が必要な場合は,次に示す運用としてください。

  • クライアントPCへの配布印刷

    クライアントPCに配布する個々の印刷データ(EPF形式ファイル)を出力するときに帳票の総ページ数を取得し,合計ページ数は計算して求める運用としてください。

  • 複数EPF形式ファイル統合出力

    個々のEPF形式ファイルを出力するときに帳票の総ページ数を出力し,合計ページ数は計算して求める運用としてください。

注※8
  • PDF形式ファイルを分割して出力する場合は,分割ページ数(setSplitPageNumberメソッド)と分割ファイル名(setOutputSplitFileNameメソッド)の両方を指定する必要があります。片方だけを指定した場合,エラー(KEEY202-E)になります。

  • PDF形式データ(getPDFReportメソッド)では指定しても無効になります。

注※9

PDF仕分け定義ファイル名(setDistributeFileNameメソッド)を指定している場合,または分割ページ数(setSplitPageNumberメソッド)と分割ファイル名(setOutputSplitFileNameメソッド)の両方を指定している場合は,指定しても無効になります。

注※10

PDF形式データ(getPDFReportメソッド)では指定できません。

注※11

指定できるプリンタ印刷方式は,「プリンタクラス名指定」または「OS上のプリンタ名指定」です。

注※12

複数様式情報定義ファイル名(setMultiFormInfoDefFileNameメソッド)と同時に指定できません。

複数様式情報定義ファイル名(setMultiFormInfoDefFileNameメソッド)を指定している場合は,新規用紙出力定義ファイル名(setPrintNewPaperFileNameメソッド),新規用紙出力定義ファイルのパス(setPrintNewPaperFilePathメソッド)を指定しても無視されます。

注※13

帳票セット指定ファイル名(setMultiReportSetFileNameメソッド)を指定している場合は,指定を省略できます。

注※14

分割ページ数(setSplitPageNumberメソッド)と分割ファイル名(setOutputSplitFileNameメソッド)の両方を指定している場合に有効となります。

注※15

Excel形式データ(getXLSXReportメソッド)では指定できません。

注※16

UNIX版のEURサーバ製品の場合は,指定しても無視されます。

重要

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のように省略して表記します。

表8‒5 情報取得メソッドの略称

略称

情報取得メソッド

GEDL

getDestinationList(出力先一覧の取得)

GEPC

getPMPrinterClassList(帳票サーバのプリンタクラス一覧の取得)

GEPP

getPMPrinterList(帳票サーバのプリンタ一覧の取得)

GEPT

getPMTrayList(帳票サーバのトレイ一覧を取得)

GECL

getPrinterClassList(プリンタクラス一覧の取得)

GEPL

getPrinterList(プリンタ一覧の取得)

GETL

getTrayList(トレイ一覧の取得)

表8‒6 EURPMAdapterForJavaクラスの情報取得メソッドで使用する設定メソッド

メソッド

設定内容

情報取得メソッド

GEDL

GEPC

GEPP

GEPT

GECL

GEPL

GETL

setAdpEnvFile

EUR Server - Adapterで使用する環境設定ファイルのパス

setDestinationName

出力先名を指定します。

setPMServerAddress

帳票サーバのIPアドレスを指定します。

setPMServerPort

帳票サーバのポート番号を指定します。

setServerPrinterName

サーバのプリンタ名を指定します。

(凡例)

○:必ず指定します。

△:指定を省略できます。

−:指定できません。