ページの先頭行へ戻る
Interstage List Works for Modernization V11.0.0 帳票印刷配信機能アプリケーション作成ガイド 帳票管理編
第3章 帳票管理Javaインタフェース > 3.9 クラスの詳細（帳票関連） > 3.9.2 Formクラス
前次

3.9.2 Formクラス

帳票属性の取得、および帳票に対する操作を行うクラスです。

このクラスは、FormManagerクラスおよびLogicalDestinationクラスのメソッドから取得されます。

java.lang.Object
  └com.fujitsu.listmanager.operate.Form


public class Form
extends java.lang.Object

3.9.2.1 フィールドの概要

FormクラスのgetApplicationTypeメソッドで取得されるフィールドを以下に示します。

FormクラスのgetApplicationTypeメソッドで取得されるフィールド

定数

説明

APPL_TYPE_COBOL_MEFT

ユーザアプリケーション種別は、COBOLアプリケーション連携機能を利用するユーザアプリケーションです。

APPL_TYPE_LISTCREATOR

ユーザアプリケーション種別は、List Manager帳票出力インタフェースを利用するユーザアプリケーションです。

APPL_TYPE_HOST

ユーザアプリケーション種別は、ホスト帳票連携機能を利用するユーザアプリケーションです。


Formクラスのpreviewメソッドで指定するフィールドを以下に示します。

Formクラスのpreviewメソッドで指定するフィールド

定数

説明

PREVIEW_OWF

プレビュー用データの種別は、OWFファイルです。

PREVIEW_PDF

プレビュー用データの種別は、PDFファイルです。


FormクラスのgetOutputStatusメソッドで取得されるフィールドを以下に示します。

FormクラスのgetOutputStatusメソッドで取得されるフィールド

定数

説明

STATUS_CANCELED

出力状態は、中止です。

STATUS_CONNECT_ERROR

出力状態は、接続エラーです。

STATUS_CREATED

出力状態は、登録です。

STATUS_FAILED

出力状態は、失敗です。

STATUS_FINISHED

出力状態は、出力済です。

STATUS_OUTPUT_ERROR

出力状態は、出力エラーです。

STATUS_OUTPUTTING

出力状態は、出力中です。

STATUS_PENDING

出力状態は、出力待ちです。

STATUS_REQUIRED

出力状態は、配信依頼です。

STATUS_SENDING

出力状態は、配信中です。

STATUS_SUSPENDED

出力状態は、出力保留です。

STATUS_WAIT_REPLY

出力状態は、応答待ちです。

STATUS_WAIT_SEND

出力状態は、配信待ちです。

3.9.2.2 メソッドの概要

Formクラスのメソッドを以下に示します。

Formクラスのメソッド

メソッドの概要

java.lang.String

getLogicalDestinationName()

出力した帳票の論理あて先名を取得します。

java.lang.String

getFileName()

帳票の帳票データファイル名を取得します。

java.lang.String

getFormID()

帳票の帳票IDを取得します。

java.lang.String

getDeliverySequenceNo()

帳票の配信通番を取得します。

int

getApplicationType()

帳票を出力したユーザアプリケーション種別を取得します。

java.lang.String

getApplicationServer()

ユーザアプリケーションを実行する帳票管理サーバの「ホスト名」または「IPアドレス」を取得します。

java.lang.String

getRequestClient()

帳票の依頼元端末の「ホスト名」または「IPアドレス」を取得します。

java.lang.String

getCreateUser()

帳票の作成ユーザを取得します。

java.util.Date

getCreateDatetime()

帳票の作成日時を取得します。

boolean

isFinished()

帳票の出力が完了したかどうかを取得します。

int

getTotalPage()

出力ページ数を取得します。

int

getPrintedPage()

帳票の出力完了ページ数を取得します。

int

getFormTotalPage()

帳票の総ページ数を取得します。

java.lang.String

getName()

帳票名を取得します。

java.lang.String

getTitle()

帳票のタイトルを取得します。

java.lang.String

getComment()

帳票のコメントを取得します。

boolean

isOutputForm()

帳票作成後の出力指定を取得します。

boolean

isKeepForm()

帳票出力後の保存指定を取得します。

java.util.Date

getSaveLimitDate()

帳票の保存期限を取得します。

int

getCopy()

帳票の出力時の印刷部数を取得します。

java.lang.String

getPaperCode()

帳票の用紙コードを取得します。

int

getOutputStatus()

帳票の出力状態を取得します。

java.lang.String

getOperatorIdInfo()

帳票の業務あて先を取得します。

java.lang.String

getPrintoutUserID()

最終出力者IDを取得します。

java.util.Data

getPrintoutDatetime()

帳票の出力依頼日時を取得します。

int

getPrintoutCount()

帳票の出力回数を取得します。

int

getPreviewCount()

帳票のプレビュー回数を取得します。

java.lang.String

getErrorSender()

帳票のエラーメッセージの送信元を取得します。

int

getErrorNo()

帳票のエラーメッセージ番号を取得します。

int

getErrorDetailCode()

帳票のエラー詳細コードを取得します。

java.lang.String

getErrorDetailMessage()

帳票のエラー詳細メッセージを取得します。

java.lang.String

getExtension()

帳票を出力したアプリケーションに対応しているファイルの拡張子を取得します。

java.lang.String

getMimeType()

帳票を出力したアプリケーションに対応しているMIMEタイプを取得します。

java.lang.String

getCustomizeItem1()

帳票のカスタマイズ項目1を取得します。

java.lang.String

getCustomizeItem2()

帳票のカスタマイズ項目2を取得します。

java.lang.String

getCustomizeItem3()

帳票のカスタマイズ項目3を取得します。

java.lang.String

getCustomizeItem4()

帳票のカスタマイズ項目4を取得します。

java.lang.String

getCustomizeItem5()

帳票のカスタマイズ項目5を取得します。

java.lang.String

getCustomizeItem6()

帳票のカスタマイズ項目6を取得します。

java.lang.String

getCustomizeItem7()

帳票のカスタマイズ項目7を取得します。

java.lang.String

getCustomizeItem8()

帳票のカスタマイズ項目8を取得します。

java.lang.String

getCustomizeItem9()

帳票のカスタマイズ項目9を取得します。

java.lang.String

getCustomizeItem10()

帳票のカスタマイズ項目10を取得します。

java.lang.String

getCustomizeItem11()

帳票のカスタマイズ項目11を取得します。

java.lang.String

getCustomizeItem12()

帳票のカスタマイズ項目12を取得します。

java.lang.String

getCustomizeItem13()

帳票のカスタマイズ項目13を取得します。

void

printout(int startPage,int endPage,int copy)

開始ページ、終了ページ、印刷部数を指定して、帳票を出力します。

void

printout(int startPage, int endPage, int copy, LMParametersList printoutOptions)

開始ページ、終了ページ、印刷部数、メッセージ通知先を指定して、帳票を出力します。

void

preview(int contentType,java.io.OutputStream out)

帳票のプレビュー用データを生成します。

void

preview(int contentType,int startPage,int endPage,java.io.OutputStream out)

開始ページ、終了ページを指定して、帳票のプレビュー用のデータを生成します。

void

preview(java.io.OutputStream out)

生成するプレビュー用データの種別を指定せず、既定形式の帳票のプレビュー用データを生成します。

void

preview(int startPage,int endPage,java.io.OutputStream out)

生成するプレビュー用データの種別を指定せず、開始ページ、終了ページを指定して、既定形式の帳票のプレビュー用データを生成します。

void

preview(OutputStream out, LMParametersList outputOptions)

開始ページ、終了ページ、プレビュー時の印刷の抑止を指定して、帳票のプレビュー用データを生成します。

void

cancel()

帳票の出力を中止します。

void

forceCancel()

帳票の出力を強制的に中止します。

void

responseError()

帳票の応答待ちへの応答を行います。

void

delete()

帳票を削除します。

void

copy(java.lang.String toLogicalDestinationName,boolean isOutput)

帳票を複写します。

java.lang.String

copy (java.lang.String toLogicalDestinationName, boolean isOutput, LMParametersList printoutOptions)

開始ページ、終了ページ、印刷部数、メッセージ通知先を指定して、帳票を複写します。

void

move(java.lang.String toLogicalDestinationName,boolean isOutput)

帳票を移動します。

void

move(java.lang.String toLogicalDestinationName,boolean isOutput,LMParametersList printoutOptions)

開始ページ、終了ページ、印刷部数、メッセージ通知先を指定して、帳票を移動します。

void

createOutputData(OutputStream out, LMParametersList outputOptions)

Webクライアントからの留置き帳票の手元出力を行う場合、留置き帳票の手元出力用データを生成します。

ポイント

各帳票属性の定義については、オンラインマニュアル“帳票印刷配信機能  セットアップガイド”を参照してください。

3.9.2.3 メソッドの詳細

public java.lang.String
getLogicalDestinationName()

用途

出力した帳票の論理あて先名を取得します。

論理あて先名は、帳票の配信時にユーザアプリケーションで指定した論理あて先名です。

戻り値

論理あて先名


public java.lang.String
getFileName()

用途

帳票の帳票データファイル名を取得します。

帳票データファイル名は、作成した帳票に対応する帳票データファイル名です。

戻り値

帳票データファイル名


public java.lang.String
getFormID()

用途

帳票の帳票IDを取得します。

帳票IDは、List Managerで、帳票を一意に識別するために割り当てられるIDです。

戻り値

帳票ID


public java.lang.String
getDeliverySequenceNo()

用途

帳票の配信通番を取得します。

配信通番は、List Managerで帳票出力サーバに配信された時点で採番されます。

戻り値

配信通番

なお、配信通番が採番されていない場合は「null」が取得されます。


public int
getApplicationType()

用途

帳票を出力したユーザアプリケーションの種別を取得します。

戻り値

ユーザアプリケーション種別を示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“FormクラスのgetApplicationTypeメソッドで取得されるフィールド”


public java.lang.String
getApplicationServer()

用途

ユーザアプリケーションを実行する帳票管理サーバの「ホスト名」または「IPアドレス」を取得します。

戻り値

ユーザアプリケーションを実行する帳票管理サーバの「ホスト名」または「IPアドレス」


public java.lang.String
getRequestClient()

用途

帳票の依頼元端末の「ホスト名」または「IPアドレス」を取得します。

依頼元端末とは、帳票登録時に指定した帳票作成依頼元の端末名です。

なお、帳票登録時に端末名を省略した場合、帳票管理サーバのホスト名です。

戻り値

依頼元端末の「ホスト名」または「IPアドレス」


public java.lang.String
getCreateUser()

用途

帳票の作成ユーザを取得します。

戻り値

作成ユーザ


public java.util.Date
getCreateDatetime()

用途

帳票の作成日時を取得します。

戻り値

作成日時


public boolean
isFinished()

用途

帳票の出力が完了したかどうかを取得します。

戻り値

true：

出力が完了した場合

false：

出力が完了していない場合、または論理あて先の論理あて先タイプがWeb手元印刷用の場合


public int
getTotalPage()

用途

出力ページ数を取得します。

出力ページ数とは、実際に出力する帳票のページ数です。

帳票出力時に、出力するページの範囲を指定した場合、指定した範囲内のページ数が取得されます。

戻り値

出力ページ数

ページ数がカウントされない場合は「0」が取得されます。

備考


public int
getPrintedPage()

用途

出力完了ページ数を取得します。

出力完了ページ数は、実際に出力が完了したページ数です。

戻り値

出力完了ページ数

ページ数がカウントされない場合は「0」が取得されます。

備考


public int
getFormTotalPage()

用途

帳票の総ページ数を取得します。

帳票の総ページ数は、帳票全体のページ数です。

戻り値

帳票の総ページ数

ページ数がカウントされない場合は「0」が取得されます。

備考


public java.lang.String
getName()

用途

帳票名を取得します。

戻り値

帳票名


public java.lang.String
getTitle()

用途

帳票のタイトルを取得します。

戻り値

タイトル


public java.lang.String
getComment()

用途

帳票のコメントを取得します。

戻り値

コメント

なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。


public boolean
isOutputForm()

用途

帳票作成後の出力指定を取得します。

帳票作成後の出力指定は、帳票作成後に続けて出力を行うかどうかの指定です。

戻り値

true：

帳票作成後に続けて出力する場合

false：

帳票作成後に続けて出力しない場合


public boolean
isKeepForm()

用途

帳票出力後の保存指定を取得します。

帳票出力後の保存指定は、帳票出力後にList Managerで帳票を保存するかどうかの指定です。

戻り値

true：

帳票出力後に帳票を保存する場合

false：

帳票出力後に帳票を保存しない場合


public java.util.Date
getSaveLimitDate()

用途

帳票の保存期限を取得します。

保存期限は、帳票を保存する期間の終点の日付を示します。

保存期限の詳細については、オンラインマニュアル“帳票印刷配信機能  運用ガイド”の“6.2.5.3  lmdelexpireコマンド”の“［補足］”を参照してください。

戻り値

保存期限（帳票を保存する期間の終点の日付）

なお、保存期限が指定されていない場合は「null」が取得されます。この「null」は、帳票が無期限に保存されることを示します。


public int
getCopy()

用途

帳票の出力時の印刷部数を取得します。

戻り値

印刷部数


public java.lang.String
getPaperCode()

用途

帳票の用紙コードを取得します。

ここで取得される用紙名は、帳票属性の編集コマンド（lmedtformatrコマンド）で指定した用紙コードです。COBOLアプリケーション連携機能の印刷属性ファイルで指定した用紙名は取得されません。

戻り値

用紙コード


public int
getOutputStatus()

用途

帳票の出力状態を取得します。

戻り値

出力状態を示すフィールドの中の1つ

フィールドの詳細については、以下を参照してください。
⇒“FormクラスのgetOutputStatusメソッドで取得されるフィールド”


public java.lang.String
getOperatorIdInfo()

用途

帳票の業務あて先を取得します。

戻り値

業務あて先

なお、業務あて先が設定されていない場合は、「null」が取得されます。


public java.lang.String
getPrintoutUserID()

用途

最終出力者IDを取得します。

戻り値

最終出力者ID

なお、最終出力者IDが設定されていない場合は、「null」が取得されます。

備考


public java.util.Date
getPrintoutDatetime()

用途

帳票の出力依頼日時を取得します。

戻り値

出力依頼日時

なお、出力依頼日時が設定されていない場合は、「null」が取得されます。

備考


public int
getPrintoutCount()

用途

帳票の出力回数を取得します。

戻り値

出力回数

備考


public int
getPreviewCount()

用途

帳票のプレビュー回数を取得します。

戻り値

プレビュー回数

備考


public java.lang.String
getErrorSender()

用途

帳票のエラーメッセージの送信元を取得します。

エラーメッセージの送信元は、出力状態が「失敗」の場合に、エラーが発生したコンピュータの名前が設定されます。

出力状態が「失敗」以外の場合に設定される値は不定です。

戻り値

エラーメッセージの送信元

エラーが発生した帳票管理サーバ名、または帳票出力サーバ名が設定されます。

なお、エラーメッセージの送信元が指定されていない場合、または半角空白だけの場合は「null」が取得されます。


public int
getErrorNo()

用途

帳票のエラーメッセージ番号を取得します。

エラーメッセージ番号は、出力状態が「失敗」の場合に、エラー発生機能IDが設定されます。

出力状態が「失敗」以外の場合に設定される値は不定です。

戻り値

エラーメッセージ番号（エラー発生機能名）

エラーメッセージ番号

エラー発生機能名

0x00000001

帳票管理サーバ

0x00000002

帳票出力サーバ

0x00000003

印刷実行アプリケーション（COBOLアプリケーション連携機能を利用するユーザアプリケーション）

0x00000004

印刷実行アプリケーション（List Manager帳票出力インタフェースを利用するユーザアプリケーション）

0x00000005

印刷実行アプリケーション（ホスト帳票連携機能を利用するユーザアプリケーション）


public int
getErrorDetailCode()

用途

帳票のエラー詳細コードを取得します。

エラー詳細コードは、出力状態が「失敗」、「出力エラー」、または「応答待ち」の場合に設定されます。出力状態が「失敗」の場合は、エラー発生原因コードが設定されます。出力状態が「出力エラー」または「応答待ち」の場合は、プリンタのエラー詳細コードが設定されます。

出力状態が「失敗」、「出力エラー」、および「応答待ち」以外の場合に設定される値は不定です。

戻り値

エラー詳細コード

エラー詳細コードについてはgetErrorDetailMessageメソッドの出力状態、エラー詳細コード、エラー詳細メッセージ表を参照してください。


public java.lang.String
getErrorDetailMessage()
throws MissingResourceException

用途

帳票のエラー詳細メッセージを取得します。

出力状態が「失敗」、「出力エラー」、または「応答待ち」の場合にエラー詳細メッセージを取得します。

戻り値

エラー詳細メッセージ

出力状態が「失敗」、「出力エラー」、または「応答待ち」以外の場合は、「null」が取得されます。

以下に出力状態、エラー詳細コードとエラー詳細メッセージの対応を示します。

出力状態

エラー詳細コード

エラー詳細メッセージ

出力エラー

0x00000001

プリンタ装置で異常が発生しました。プリンタ装置を確認してください。

出力エラー

0x00000002

プリンタ装置で異常が発生しました。プリンタ装置を確認してください。

出力エラー

0x00000004

プリンタ装置で異常が発生しました。プリンタ装置を確認してください。

出力エラー

0x00000008

プリンタ装置で用紙詰まりが発生したため印刷できません。詰まった用紙を取り除いてください。

出力エラー

0x00000010

プリンタ装置で用紙切れのため印刷できません。用紙を補給してください。

出力エラー

0x00000020

プリンタ装置で手差しトレイへの用紙補給待ちです。手差しトレイに用紙を補給してください。

出力エラー

0x00000040

プリンタ装置で用紙エラーが発生しました。プリンタ装置を確認してください。

出力エラー

0x00000080

プリンタ装置がオフライン状態のため印刷できません。オンライン状態にしてください。

出力エラー

0x00000800

プリンタ装置で排出トレイが一杯になったため印刷できません。排出トレイの用紙を取り除いてください。

出力エラー

0x00020000

プリンタ装置でトナーの残量が少なくなったため印刷できません。トナーを交換してください。

出力エラー

0x00040000

プリンタ装置でトナーがなくなったため印刷できません。トナーを交換してください。

出力エラー

0x00100000

プリンタ装置でユーザ操作が必要な状態です。プリンタ装置を確認してください。

出力エラー

0x00200000

プリンタ装置でメモリ不足のため印刷できません。プリンタ装置を確認してください。

出力エラー

0x00400000

プリンタ装置でカバーが開いているため印刷できません。カバーを閉じてください。

出力エラー

0x10000000

プリンタ装置で異常が発生しました。プリンタ装置を確認してください。

出力エラー

0x40000000

プリンタ装置でハード異常が発生しました。プリンタ装置を確認してください。

出力エラー

0x80000000

プリンタ装置と通信できません。プリンタ装置、または接続環境を確認してください。

応答待ち

0x20000000

ユーザ応答待ちです。ユーザ応答待ちに応答してください。

失敗

0x00020000

メモリが不足しています。不要なアプリケーションを終了し、再度、失敗した操作を実行してください。

失敗

0x00030000

ディスクが不足しています。ディスクの空き容量を確認し、不要なファイルを削除して、再度、失敗した操作を実行してください。

失敗

0x00040000

リソースが不足しています。不要なアプリケーションを終了する、仮想メモリを増やす、またはメモリを増設し、再度、失敗した操作を実行してください。

失敗

0x00050000

ファイル、またはディレクトリへのアクセスに失敗しました。異常となったファイル、またはディレクトリの権限を見直し、再度、失敗した操作を実行してください。

失敗

0x00060000

必要な帳票資源が配置されていません。帳票資源の配置ディレクトリの指定に誤りがないか、または、帳票資源が正しく配置されているかを確認し、再度、アプリケーションを実行してください。

失敗

0x00060201

帳票定義情報が見つかりません。帳票定義情報の指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060202

配置されている資源に異常があります。帳票資源が壊れていないか確認してください。

失敗

0x00060203

配置されている資源に異常があります。帳票資源が壊れていないか確認してください。

失敗

0x00060301

オーバレイファイルが見つかりません。オーバレイファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060401

メディアデータファイルが見つかりません。メディアデータファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060501

プリンタ情報ファイルが見つかりません。プリンタ情報ファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060502

プリンタ情報ファイルの内容に誤りがあります。プリンタ情報ファイルの内容を見直し、再度、アプリケーションを実行してください。

失敗

0x00060601

帳票出力に使用する初期化ファイル、または情報ファイルが見つかりません。帳票出力に使用する初期化ファイル、または情報ファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060a01

PDFメール配信に使用するファイルが見つかりません。PDFメール配信に使用するファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060b01

必要な帳票資源が配置されていません。帳票資源の配置ディレクトリの指定に誤りがないか、または、帳票資源が正しく配置されているかを確認し、再度、アプリケーションを実行してください。

失敗

0x00060d01

PDFに添付するファイルが見つかりません。PDFに添付するファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00060e01

帳票の入力データファイルが見つかりません。帳票の入力データファイルを確認し、再度、アプリケーションを実行してください。

失敗

0x00060f01

アプリケーションで指定した転送ファイルが見つかりません。転送ファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00061001

アプリケーションで指定したバイナリ転送ファイルが見つかりません。バイナリ転送ファイルの指定を確認し、再度、アプリケーションを実行してください。

失敗

0x00061101

初期化ファイル、または情報ファイル中に、必要なセクションが見つかりません。必要なセクションを指定後、再度、アプリケーションを実行してください。

失敗

0x00061301

指定されたフォントファイルのアクセスに失敗しました。指定したフォントファイルが存在するか、またはアクセス権があるか確認してください。

失敗

0x00061302

指定されたフォントファイルが壊れている可能性があります。指定したフォントファイルがTrueType フォントファイルか確認してください。

失敗

0x00061303

指定された外字フォントファイルのアクセスに失敗しました。指定した外字フォントファイルが存在するか、または、アクセス権があるかを確認してください。

失敗

0x00061304

指定されたフォント番号のフォントが、フォントファイルに見つかりません。指定したフォント番号を確認してください。

失敗

0x00061401

帳票データファイル格納ディレクトリ配下のアクセス権を確認してください。List Managerを移行した場合は、帳票データファイルが確実に移行されたことを確認してください。

失敗

0x00070000

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070001

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070002

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070003

ファイル、またはディレクトリへのアクセスに失敗しました。異常となったファイル、またはディレクトリの権限を見直し、再度、失敗した操作を実行してください。

失敗

0x00070004

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070103

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x00070201

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070202

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070301

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070401

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070402

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00070501

環境変数の指定に誤りがあります。環境変数を確認し、再度、アプリケーションを実行してください。

失敗

0x00070601

ファイル、またはディレクトリが存在しません。異常となったファイル、またはディレクトリが存在するか確認し、再度、失敗した操作を実行してください。

失敗

0x00070801

システム時間が異常です。システムの時間設定、または帳票定義情報の更新日時を確認してください。

失敗

0x00070901

帳票の出力処理でタイムアウトが発生しました。帳票出力サーバのサービス（「PRT Server Service」「WORKIT MSG(F3BW)」）が起動されているか確認し、再度、帳票を出力してください。

失敗

0x00071001

ファイルをオープンできる上限を超えている可能性があります。システム環境を見直してください。

失敗

0x00071101

ファイル、またはディレクトリが作成できません。ファイル、またはディレクトリのフルパスがOSのパスの最大長より短くなるように変更してください。

失敗

0x00072001

帳票登録後に続けて、帳票を出力することができませんでした。指定された帳票登録後の出力指定、または、帳票属性の出力処理モードに設定した値に誤りがないか確認してください。

失敗

0x00072002

出力ファイルを作成できませんでした。出力方法に設定した値に誤りがないか確認してください。

失敗

0x00073001

必要なライブラリが見つかりませんでした。ライブラリを配置したか、パスが通っているか確認してください。

失敗

0x00073002

ライブラリが正しくありません。指定したライブラリが正しいか、およびライブラリの動作環境を確認してください。

失敗

0x0007ffff

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x00080000

帳票出力サーバへの通信に失敗しました。帳票出力サーバが動作していない、または高負荷状態でないか確認してください。

失敗

0x00080001

帳票出力サーバへの通信に失敗しました。帳票出力サーバが動作していない、または高負荷状態でないか確認してください。

失敗

0x00080002

帳票出力サーバへの通信に失敗しました。ネットワーク環境、および帳票出力サーバの動作を確認し、再度、失敗した操作を実行してください。

失敗

0x00080003

帳票出力サーバへの通信に失敗しました。ネットワーク環境、および帳票出力サーバの動作を確認し、再度、失敗した操作を実行してください。

失敗

0x00080004

帳票出力サーバへの通信に失敗しました。ホスト名を解決するための設定を確認し、再度、失敗した操作を実行してください。

失敗

0x00080005

帳票出力サーバへの通信に失敗しました。ネットワーク環境、および帳票出力サーバの動作を確認し、再度、失敗した操作を実行してください。

失敗

0x00080006

IPアドレス、またはポート番号が利用できません。環境設定のIPアドレス(TcpBindAddress)、またはポート番号(TcpSvrPortNum)を確認してください。

失敗

0x00090101

COBOLアプリケーションが出力するデータが異常です。COBOLアプリケーションが出力するデータを見直し、再度、帳票を出力してください。

失敗

0x000a0000

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000a0001

データベースに接続できませんでした。データベースが起動しているか、または環境設定が正しいかどうかを確認してください。

失敗

0x000a0002

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000a0003

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000a0004

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000a0005

高負荷のためデータベースのアクセスで資源不足が発生しました。再度、失敗した操作を実行してください。

失敗

0x000a0006

データベースの最大同時接続数に達していたため接続できませんでした。データベースの環境を見直してください。

失敗

0x000a0007

データベースのアクセスでエラーが発生しました。データベースの動作、および環境を見直してください。

失敗

0x000a0008

データベースのアクセスでエラーが発生しました。データベースの動作、および環境を見直してください。

失敗

0x000a0009

データベースのアクセスでエラーが発生しました。データベースの動作、および環境を見直してください。

失敗

0x000a000b

複写可能な最大数を超えました。複写元の帳票を確認して登録し直してください。

失敗

0x000a000c

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000a0010

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000a0099

データベースのアクセスでエラーが発生しました。データベースの環境を見直してください。

失敗

0x000c0404

動作環境が異常です。システム環境、製品のインストール状態、および帳票管理サーバの環境設定ファイルの内容を見直し、再度、実行してください。

失敗

0x000c0501

ページ指定エラーです。指定したページ数が帳票のページ数の範囲内であるか、またはページ指定可能な帳票であるか確認してください。

失敗

0x000c0504

出力先のプリンタへアクセスできませんでした。プリンタが定義されているか、または、プリンタに対して出力する権限があるか確認してください。

失敗

0x000c0601

論理あて先に登録されている論理デバイスの出力方法が異常です。論理あて先に登録されている論理デバイスを、他の出力方法が設定されている論理デバイスに切り替えてください。

失敗

0x000e0400

帳票出力で異常が発生しました。帳票出力サーバの動作を確認し、再度、失敗した操作を実行してください。

失敗

0x000e0410

ログオンできませんでした。Windowsにユーザが登録されていること、およびユーザの権限を確認してください。

失敗

0x000d0000

文字コード変換で異常が発生しました。文字コードに関する設定を確認し、再度、アプリケーションを実行して下さい。

失敗

0xfffe0001

ファイル、またはディレクトリが存在しません。異常となったファイル、またはディレクトリが存在するか確認し、再度、失敗した操作を実行してください。

失敗

0xfffe0002

メモリが不足しています。不要なアプリケーションを終了し、再度、失敗した操作を実行してください。

失敗

0xfffe0003

ファイル、またはディレクトリへのアクセスに失敗しました。異常となったファイル、またはディレクトリの権限を見直し、再度、失敗した操作を実行してください。

失敗

0xfffe0004

ファイル、またはディレクトリのパスが存在しません。異常となったファイル、またはディレクトリのパスが存在するか確認し、再度、失敗した操作を実行してください。

失敗

0xfffe0005

パスが長すぎる、もしくは無効な名前が指定されました。異常となったパスを見直して、再度、失敗した操作を実行してください。

失敗

0xfffe0007

リソースが不足しています。不要なアプリケーションを終了する、仮想メモリを増やす、またはメモリを増設し、再度、失敗した操作を実行してください。

失敗

0xfffe0008

ディスクが不足しています。ディスクの空き容量を確認し、不要なファイルを削除して、再度、失敗した操作を実行してください。

失敗

0xffff1000

帳票出力で異常が発生しました。詳細はMeFtのイベントログを参照してエラー原因を取り除き、再度、帳票を出力してください。

失敗

0xffff2000

帳票出力で異常が発生しました。詳細はFJSVoastのシステムログを参照してエラー原因を取り除き、再度、帳票を出力してください。

失敗

0xffff3000

帳票出力で異常が発生しました。帳票出力サーバの動作を確認し、再度、失敗した操作を実行してください。

失敗

0xffff4000

帳票出力で異常が発生しました。帳票出力サーバの動作を確認し、再度、失敗した操作を実行してください。

出力エラー
応答待ち
失敗

上記以外

異常が発生しました。繰り返し発生する場合には、障害調査用情報採取ツールを使用して調査資料を採取し、当社技術員に連絡してください。

例外

MissingResource Exception：

動作環境が異常な状態で実行した場合


public java.lang.String
getExtension()

用途

帳票を出力したアプリケーションに対応しているファイルの拡張子を取得します。

取得した拡張子は、プレビュー用データをファイルにする場合に、ファイル名の拡張子として使用します。

戻り値

ファイルの拡張子（「owf」または「pdf」）

取得されるファイルの拡張子は、ユーザアプリケーション種別によって、以下のように異なります。

ユーザアプリケーション種別

取得されるファイルの拡張子

COBOLアプリケーション連携機能を利用するユーザアプリケーション

owf

List Manager帳票出力インタフェースを利用するユーザアプリケーション

ホスト帳票連携機能を利用するユーザアプリケーション

pdf


public java.lang.String
getMimeType()

用途

帳票を出力したユーザアプリケーションに対応しているMIMEタイプを取得します。

取得したMIMEタイプは、プレビュー用データをWebブラウザに表示する場合に使用します。

戻り値

MIMEタイプ（「application/x-owf」または「application/pdf」）

取得されるMIMEタイプは、ユーザアプリケーション種別によって、以下のように異なります。

ユーザアプリケーション種別

取得されるMIMEタイプ

COBOLアプリケーション連携機能を利用するユーザアプリケーション

application/x-owf

List Manager帳票出力インタフェースを利用するユーザアプリケーション

ホスト帳票連携機能を利用するユーザアプリケーション

application/pdf


public java.lang.String
getCustomizeItem1()

用途

帳票のカスタマイズ項目1を取得します。

戻り値

カスタマイズ項目1の値

なお、カスタマイズ項目1が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem2()

用途

帳票のカスタマイズ項目2を取得します。

戻り値

カスタマイズ項目2の値

なお、カスタマイズ項目2が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem3()

用途

帳票のカスタマイズ項目3を取得します。

戻り値

カスタマイズ項目3の値

なお、カスタマイズ項目3が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem4()

用途

帳票のカスタマイズ項目4を取得します。

戻り値

カスタマイズ項目4の値

なお、カスタマイズ項目4が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem5()

用途

帳票のカスタマイズ項目5を取得します。

戻り値

カスタマイズ項目5の値

なお、カスタマイズ項目5が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem6()

用途

帳票のカスタマイズ項目6を取得します。

戻り値

カスタマイズ項目6の値

なお、カスタマイズ項目6が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem7()

用途

帳票のカスタマイズ項目7を取得します。

戻り値

カスタマイズ項目7の値

なお、カスタマイズ項目7が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem8()

用途

帳票のカスタマイズ項目8を取得します。

戻り値

カスタマイズ項目8の値

なお、カスタマイズ項目8が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem9()

用途

帳票のカスタマイズ項目9を取得します。

戻り値

カスタマイズ項目9の値

なお、カスタマイズ項目9が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem10()

用途

帳票のカスタマイズ項目10を取得します。

戻り値

カスタマイズ項目10の値

なお、カスタマイズ項目10が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem11()

用途

帳票のカスタマイズ項目11を取得します。

戻り値

カスタマイズ項目11の値

なお、カスタマイズ項目11が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem12()

用途

帳票のカスタマイズ項目12を取得します。

戻り値

カスタマイズ項目12の値

なお、カスタマイズ項目12が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public java.lang.String
getCustomizeItem13()

用途

帳票のカスタマイズ項目13を取得します。

戻り値

カスタマイズ項目13の値

なお、カスタマイズ項目13が設定されていない場合、または半角空白だけの場合は「null」が取得されます。


public void
printout(int startPage,int endPage,int copy)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

開始ページ、終了ページ、印刷部数を指定して、帳票を出力します。

帳票の出力状態が「失敗」、「登録」、「中止」、「出力済」の帳票を出力します。帳票の出力状態が「出力保留」の帳票に対しては、帳票の出力の保留を解除します。

パラメータ

startPage：

帳票出力を開始するページ数を1～99999999（最大8桁）の範囲で指定します。

  • 「0」を指定した場合、1ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合は、ユーザアプリケーションで指定した開始 ページが有効になります。

  • 帳票の出力状態が「失敗」、「登録」、「中止」、「出力済」の場合、帳票の総ページ数より大きな値を指定すると、帳票出力時に帳票出力サーバでエラーとなります。

COBOLアプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～99999（最大5桁）の範囲です。

帳票の総ページ数が100000ページ以上の場合は、以下の点に注意してください。

  • startPageパラメータに1～99999の範囲の値を指定し、endPageパラメータに「0」を指定した場合、指定した開始ページから99999ページ目まで出力されます。

  • 100000ページ目以降のページを出力したい場合、startPageパラメータおよびendPageパラメータに「0」を指定し、すべてのページを出力する必要があります。

endPage：

帳票出力を終了するページ数を1～99999999（最大8桁）の範囲で指定します。

  • startPageパラメータで開始ページを指定した場合、その開始ページ以降のページ番号を指定します。

  • 「0」を指定した場合、最終ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した終了 ページが有効になります。

COBOLアプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～99999（最大5桁）の範囲です。

帳票の総ページ数が100000ページ以上の場合は、以下の点に注意してください。

  • startPageパラメータに1～99999の範囲の値を指定し、endPageパラメータに「0」を指定した場合、指定した開始ページから99999ページ目まで出力されます。

  • 100000ページ目以降のページを出力したい場合、startPageパラメータおよびendPageパラメータに「0」を指定し、すべてのページを出力する必要があります。

copy：

印刷部数を 1～999 の範囲で指定します。

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
printout(int startPage, int endPage, int copy, LMParametersList printoutOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

開始ページ、終了ページ、印刷部数、メッセージ通知先を指定して、帳票を出力します。

帳票の出力状態が「失敗」、「登録」、「中止」、「出力済」の帳票を出力します。帳票の出力状態が「出力保留」の帳票に対しては、帳票の出力の保留を解除します。

パラメータ

startPage：

帳票出力を開始するページ数を1～99999999（最大8桁）の範囲で指定します。

  • 「0」を指定した場合、1ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した開始 ページが有効になります。

  • 帳票の出力状態が「失敗」、「登録」、「中止」、「出力済」の場合、帳票の総ページ数より大きな値を指定すると、帳票出力時に帳票出力サーバでエラーとなります。

COBOLアプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～99999（最大5桁）の範囲です。

帳票の総ページ数が100000ページ以上の場合は、以下の点に注意してください。

  • startPageパラメータに1～99999の範囲の値を指定し、endPageパラメータに「0」を指定した場合、指定した開始ページから99999ページ目まで出力されます。

  • 100000ページ目以降のページを出力したい場合、startPageパラメータおよびendPageパラメータに「0」を指定し、すべてのページを出力する必要があります。

endPage：

帳票出力を終了するページ数を1～99999999（最大8桁）の範囲で指定します。

  • startPageパラメータで開始ページを指定した場合、その開始ページ以降のページ番号を指定します。

  • 「0」を指定した場合、最終ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した終了 ページが有効になります。

COBOLアプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～99999（最大5桁）の範囲です。

帳票の総ページ数が100000ページ以上の場合は、以下の点に注意してください。

  • startPageパラメータに1～99999の範囲の値を指定し、endPageパラメータに「0」を指定した場合、指定した開始ページから99999ページ目まで出力されます。

  • 100000ページ目以降のページを出力したい場合、startPageパラメータおよびendPageパラメータに「0」を指定し、すべてのページを出力する必要があります。

copy：

印刷部数を 1～999 の範囲で指定します。

「0」を指定した場合は、例外(Illegal ArgumentException)が発生します。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプリケーションで指定した印刷部数が有効になります。

printoutOptions：

メッセージ通知先を、LMParameterKeyクラスの以下の値で指定します。

  • PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
    返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
    メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

  • PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
    通知メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
    メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
preview(int contentType,java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

帳票のプレビュー用データを生成します。

生成するプレビュー用データの種別を contentTypeパラメータで指定します。

パラメータ

contentType：

生成するプレビュー用データの種別を示すフィールドを指定します。

フィールドの詳細については、以下を参照してください。
⇒“Formクラスのpreviewメソッドで指定するフィールド”

out：

プレビュー用データを書き込むストリームを指定します。

例外

OperateForm Exception：

プレビュー用データの生成処理でエラーが発生した場合

java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
preview(int contentType,int startPage,int endPage,java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

開始ページ、終了ページを指定して、帳票のプレビュー用のデータを生成します。

生成するプレビュー用データの種別を contentTypeパラメータで指定します。

パラメータ

contentType：

生成するプレビュー用データの種別を示すフィールドを指定します。

フィールドの詳細については、以下を参照してください。
⇒“Formクラスのpreviewメソッドで指定するフィールド”

startPage：

プレビュー用のデータの生成を開始するページ番号を指定します。

指定方法は、以下のとおりです。

  • contentTypeパラメータに「PREVIEW_PDF」を指定した場合
    1～99999999（最大8桁）の範囲で指定します。
    「0」を指定すると、1ページが指定されたとみなされます。

  • contentTypeパラメータに「PREVIEW_OWF」を指定した場合
    必ず「0」を指定してください（ページ範囲は指定できません）。

endPage：

プレビュー用のデータの生成を終了するページ番号を指定します。

指定方法は、以下のとおりです。

  • contentTypeパラメータに「PREVIEW_PDF」を指定した場合
    1～99999999（最大8桁）の範囲で指定します。

    • startPageパラメータで開始ページを指定した場合、ユーザアプリケーションで指定した開始ページ以降のページ番号を指定します。

    • 「0」を指定すると、最終ページが指定されたとみなされます。

  • contentTypeパラメータに「PREVIEW_OWF」を指定した場合
    必ず「0」を指定してください（ページ範囲は指定できません）。

out：

プレビュー用データを書き込むストリームを指定します。

例外

OperateForm Exception：

プレビュー用データの生成処理でエラーが発生した場合

java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
preview(java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

生成するプレビュー用データの種別を指定せず、既定形式の帳票のプレビュー用データを生成します。

パラメータ

out：

プレビュー用データを書き込むストリームを指定します。

例外

OperateForm Exception：

プレビュー用データの生成処理でエラーが発生した場合

java.lang.Illegal ArgumentException：

データを書き込むストリームが「null」の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
preview(int startPage,int endPage,java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

生成するプレビュー用データの種別を指定せず、開始ページ、終了ページを指定して、既定形式の帳票のプレビュー用データを生成します。

パラメータ

startPage：

プレビュー用のデータの生成を開始するページ番号を指定します。

指定方法は、以下のとおりです。

  • プレビュー時のファイル形式が「PDFファイル」の場合
    1～99999999（最大8桁）の範囲で指定します。
    「0」を指定した場合、1 ページが指定されたとみなされます。

  • プレビュー時のファイル形式が「OWFファイル」の場合
    必ず「0」を指定してください（ページ範囲は指定できません）。

endPage：

プレビュー用のデータの生成を終了するページ番号を指定します。

指定方法は、以下のとおりです。

  • プレビュー時のファイル形式が「PDFファイル」の場合
    1～99999999（最大8桁）の範囲で指定します。

    • startPageパラメータで開始ページを指定した場合、その開始ページ以降のページ番号を指定します。

    • 「0」を指定した場合、最終ページが指定されたとみなされます。

  • プレビュー時のファイル形式が「OWFファイル」の場合
    必ず「0」を指定してください（ページ範囲は指定できません）。

out：

プレビュー用データを書き込むストリームを指定します。

例外

OperateForm Exception：

プレビュー用データの生成処理でエラーが発生した場合

java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
preview(OutputStream out, LMParametersList outputOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

開始ページ、終了ページ、プレビュー時の印刷の抑止を指定して、帳票のプレビュー用データを生成します。

パラメータ

out：

プレビュー用データを書き込むストリームを指定します。

outputOptions：

プレビュー用データの生成のオプションを、LMParameterKeyクラスの以下のキーで指定します。「null」を指定した場合、各指定項目の初期値が指定されたとみなされます。

  • PARAM_CONTENT_TYPE（プレビュー用データの種別）
    生成するプレビュー用データの種別を指定します。指定できる値は、運用形態とユーザアプリケーション種別によって、以下のように異なります。

    運用形態

    ユーザアプリケーション種別

    指定できる値

    プレビュー時のファイル
    形式

    帳票配信型

    COBOL アプリケーション連携機能を利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_OWF
    (*1)

    OWF ファイル

    List Manager 帳票出力インタフェースを利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_OWF
    (*1)

    OWF ファイル

    OPTION_CONTENT_TYPE_PDF

    PDF ファイル

    ホスト帳票連携機能を利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_PDF
    (*1)

    PDF ファイル

    Web手元印刷

    List Manager帳票出力インタフェースを利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_OWF

    OWFファイル

    OPTION_CONTENT_TYPE_PDF
    (*1)

    PDFファイル

        *1：
        プレビュー用データの種別の指定を省略した場合、指定されたとみなされる値を示しています。

    上記以外の組み合わせでは、指定できません。指定した場合は、例外が発生するか、または動作の保証ができません。

  • PARAM_START_PAGE（プレビューの開始ページ）
    プレビュー用データの生成を開始するページ番号をIntegerオブジェクトで指定します。

    • プレビュー用データの種別に「OPTION_CONTENT_TYPE_PDF」を指定した場合
      1～ 99999999（最大8桁）の範囲で指定します。
          - 「0」を指定すると1ページが指定されたとみなされます。
          - 開始ページを指定しなかった場合、「0」が指定されたとみなされます。

    • プレビュー用データの種別に「OPTION_CONTENT_TYPE_OWF」を指定した場合
      必ず「0」を指定してください（ページ範囲は指定できません）。

  • PARAM_END_PAGE（プレビューの終了ページ）
    プレビュー用データの生成を終了するページ番号をIntegerオブジェクトで指定します。

    • プレビュー用データの種別に「OPTION_CONTENT_TYPE_PDF」を指定した場合
      1～ 99999999（最大8桁）の範囲で指定します。
          - 開始ページを指定した場合、その開始ページ以降のページ番号を指定します。
          - 「0」を指定すると最終ページが指定されたとみなされます。
          - 終了ページを指定しなかった場合、「0」が指定されたとみなされます。

    • プレビュー用データの種別に「OPTION_CONTENT_TYPE_OWF」を指定した場合
      必ず「0」を指定してください（ページ範囲は指定できません）。

  • PARAM_OUTPUT_MASKED（プレビュー時の印刷の抑止）

    • 「OPTION_CONTENT_TYPE_OWF」を指定した場合は、以下の値で指定します。
          - OPTION_USE_APPLICATION（プレビュー時の印刷の抑止指定は、帳票登録時の指定にしたがう）
          - OPTION_OUTPUT_MASKED_FALSE（プレビュー時の印刷を抑止しない）
          - OPTION_OUTPUT_MASKED_TRUE（プレビュー時の印刷を抑止する）
          - OPTION_OUTPUT_MASKED_TWICE_DISABLE（2 重印刷を抑止する）

    • 「OPTION_CONTENT_TYPE_PDF」を指定した場合は、以下の値で指定します。
          - OPTION_USE_APPLICATION（プレビュー時の印刷の抑止指定は、帳票登録時の指定にしたがう）
          - OPTION_OUTPUT_MASKED_FALSE（プレビュー時の印刷を抑止しない）
          - OPTION_OUTPUT_MASKED_TRUE（プレビュー時の印刷を抑止する）

    この値を省略した場合、「OPTION_USE_APPLICATION」が指定されたとみなされます。

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
cancel()
throws OperateFormException,java.lang.IllegalStateException

用途

帳票の出力を中止します。

論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。

帳票の出力中止が完了すると、帳票の出力状態が「中止」に変更されます。

例外

OperateForm Exception：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
forceCancel()
throws OperateFormException,java.lang.IllegalStateException

用途

帳票の出力を強制的に中止します。

論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。

例外

OperateForm Exception：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
responseError()
throws OperateFormException,java.lang.IllegalStateException

用途

帳票の応答待ちへの応答を行います。

出力状態が「応答待ち」の帳票に対してのみ応答できます。

例外

OperateForm Exception：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意


public void
delete()
throws OperateFormException,java.lang.IllegalStateException

用途

帳票を削除します。

例外

OperateForm Exception：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意


public void
copy(java.lang.String toLogicalDestinationName,boolean isOutput)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException

用途

帳票を複写します。

複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

パラメータ

toLogicalDestinationName：

複写先の論理あて先名を指定します。

論理あて先グループを複写先論理あて先にすることはできません。

isOutput：

複写後に、複写した帳票の出力を行うかどうかを指定します。

true：

複写後に帳票を出力する場合に指定します。

false：

複写後に帳票を出力しない場合に指定します。

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：

複写先の論理あて先名が「null」の場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public java.lang.String
copy
(java.lang.String toLogicalDestinationName, boolean isOutput, LMParametersList printoutOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

開始ページ、終了ページ、印刷部数、メッセージ通知先を指定して、帳票を複写します。

複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

パラメータ

toLogicalDestinationName：

複写先の論理あて先名を指定します。

論理あて先グループを複写先論理あて先にすることはできません。

isOutput：

複写後に、複写した帳票の出力を行うかどうかを指定します。

true：

複写後に帳票を出力する場合に指定します。

false：

複写後に帳票を出力しない場合に指定します。

printoutOptions：

開始ページ、終了ページ、印刷部数、メッセージ通知先を、LMParameterKeyクラスの以下のキーで指定します。複写と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）に有効になります。

  • PARAM_PRINTOUT_START_PAGE（帳票出力時の開始ページ）
    帳票出力時の開始ページをIntegerオブジェクトで指定します。指定可能なページ数は、1～99999999（最大8桁）の範囲です。

    • 「0」を指定した場合は、1 ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した開始 ページが有効になります。

    • 開始ページを指定しなかった場合は、「0」が指定されたとみなされます。

    COBOL アプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～ 99999（最大5 桁）の範囲です。

    帳票の総ページ数が100000 ページ以上の場合は、以下の点に注意してください。

    • 「PARAM_PRINTOUT_START_PAGE」の値に1～99999の範囲の値を指定し、「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定した場合、指定した開始ページから99999 ページ目まで出力されます。

    • 100000 ページ目以降のページを出力したい場合、「PARAM_PRINTOUT_START_PAGE」の値および「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定し、すべてのページを出力する必要があります。

    • 帳票の総ページ数より大きな値を指定した場合、帳票出力サーバでエラーとなります。

  • PARAM_PRINTOUT_END_PAGE（帳票出力時の終了ページ）
    帳票出力時の終了ページをIntegerオブジェクトで指定します。指定可能なページ数は、1～99999999（最大8桁）の範囲です。

    • 開始ページを指定した場合は、その開始ページ以降のページを指定します。

    • 「0」を指定した場合は、最終ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した終了 ページが有効になります。

    • 終了ページを指定しなかった場合は、「0」が指定されたとみなされます。

    COBOL アプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～ 99999（最大5 桁）の範囲です。

    帳票の総ページ数が100000 ページ以上の場合は、以下の点に注意してください。

    • 「PARAM_PRINTOUT_START_PAGE」の値に1～99999の範囲の値を指定し、「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定した場合、指定した開始ページから99999 ページ目まで出力されます。

    • 100000 ページ目以降のページを出力したい場合、「PARAM_PRINTOUT_START_PAGE」の値および「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定し、すべてのページを出力する必要があります。

  • PARAM_PRINTOUT_COPY（印刷部数）
    帳票出力時の印刷部数をIntegerオブジェクトで指定します。
    指定可能な印刷部数は1～ 999の範囲です。

    • 「0」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプリケーションで指定した印刷部数が有効になります。

    • 印刷部数を指定しなかった場合は、「0」が指定されたとみなされます。

  • PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
    返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
    メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

  • PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
    通知メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
    メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

戻り値

複写した帳票の帳票ID

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
move(java.lang.String toLogicalDestinationName,boolean isOutput)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

帳票を移動します。

移動は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

パラメータ

toLogicalDestinationName：

移動先の論理あて先名を指定します。
論理あて先グループを移動先論理あて先にすることはできません。

isOutput：

移動後に、移動した帳票の出力を行うかどうかを指定します。

true：

移動後に帳票を出力する場合に指定します。

false：

移動後に帳票を出力しない場合に指定します。

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：

移動先の論理あて先名に「null」を指定した場合

java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
move(java.lang.String toLogicalDestinationName,boolean isOutput,LMParametersList printoutOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

開始ページ、終了ページ、印刷部数、メッセージ通知先を指定して、帳票を移動します。

移動は、同じ論理あて先タイプの論理あて先に対してのみ行えます。

パラメータ

toLogicalDestinationName：

移動先の論理あて先名を指定します。
論理あて先グループを移動先論理あて先にすることはできません。

isOutput：

移動後に、移動した帳票の出力を行うかどうかを指定します。

true：

移動後に帳票を出力する場合に指定します。

false：

移動後に帳票を出力しない場合に指定します。

printoutOptions：

開始ページ、終了ページ、印刷部数、メッセージ通知先を、LMParameterKeyクラスの以下のキーで指定します。移動と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）に有効になります。

  • PARAM_PRINTOUT_START_PAGE（帳票出力時の開始ページ）
    帳票出力時の開始ページをIntegerオブジェクトで指定します。指定可能なページ数は、1～99999999（最大8桁）の範囲です。

    • 「0」を指定した場合は、1 ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した開始 ページが有効になります。

    • 開始ページを指定しなかった場合は、「0」が指定されたとみなされます。

    • 帳票の総ページ数より大きな値を指定すると、帳票出力時に帳票出力サーバでエラーとなります。

    COBOL アプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～ 99999（最大5 桁）の範囲です。

    帳票の総ページ数が100000 ページ以上の場合は、以下の点に注意してください。

    • 「PARAM_PRINTOUT_START_PAGE」の値に1～99999の範囲の値を指定し、「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定した場合、指定した開始ページから99999 ページ目まで出力されます。

    • 100000 ページ目以降のページを出力したい場合、「PARAM_PRINTOUT_START_PAGE」の値および「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定し、すべてのページを出力する必要があります。

  • PARAM_PRINTOUT_END_PAGE（帳票出力時の終了ページ）
    帳票出力時の終了ページをIntegerオブジェクトで指定します。指定可能なページ数は1～99999999（最大8桁）の範囲です

    • 開始ページを指定した場合は、その開始ページ以降のページを指定します。

    • 「0」を指定した場合は、最終ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した終了 ページが有効になります。

    • 終了ページを指定しなかった場合は、「0」が指定されたとみなされます。

    COBOL アプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～ 99999（最大5 桁）の範囲です。

    帳票の総ページ数が100000 ページ以上の場合は、以下の点に注意してください。

    • 「PARAM_PRINTOUT_START_PAGE」の値に1～99999の範囲の値を指定し、「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定した場合、指定した開始ページから99999 ページ目まで出力されます。

    • 100000 ページ目以降のページを出力したい場合、「PARAM_PRINTOUT_START_PAGE」の値および「PARAM_PRINTOUT_END_PAGE」の値に「0」を指定し、すべてのページを出力する必要があります。

  • PARAM_PRINTOUT_COPY（印刷部数）
    帳票出力時の印刷部数をIntegerオブジェクトで指定します。
    指定可能な印刷部数は1～ 999の範囲です。

    • 「0」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプリケーションで指定した印刷部数が有効になります。

    • 印刷部数を指定しなかった場合は、「0」が指定されたとみなされます。

  • PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
    返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
    メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

  • PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
    通知メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
    メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。

例外

OperateForm Exception：
java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”

注意

備考


public void
createOutputData(OutputStream out, LMParametersList outputOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException

用途

Webクライアントからの留置き帳票の手元出力を行う場合、留置き帳票の手元出力用データを生成します。

パラメータ

out：

留置き帳票の手元出力用データを書き込むストリームを指定します。

outputOptions：

留置き帳票の手元出力用データのオプションを、LMParameterKeyクラスの留置き帳票の手元出力用データのオプションを以下のキーで指定します。「null」を指定した場合、各キーの初期値が指定されたとみなされます。

  • PARAM_CONTENT_TYPE（留置き帳票の手元出力用データの種別）
    生成する留置き帳票の手元出力用データの種別を指定します。指定できる値は、ユーザアプリケーション種別によって、以下のように異なります。

    運用形態

    ユーザアプリケーション種別

    指定できる値

    留置き帳票の手元出力用データのファイル形式

    帳票配信型

    COBOL アプリケーション連携機能を利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_OWF
    (*1)

    OWFファイル

    List Manager 帳票出力インフェースを利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_OWF
    (*1)

    OWFファイル

    OPTION_CONTENT_TYPE_PDF

    PDFファイル

    ホスト帳票連携機能を利用するユーザアプリケーション

    OPTION_CONTENT_TYPE_PDF
    (*1)

    PDFファイル

        *1：
        留置き帳票の手元出力用データの種別の指定を省略した場合、指定されたとみなされる値を示しています。

    • 上記以外の組み合わせでは、指定できません。指定した場合、例外が発生するか、または動作の保証ができません。

  • PARAM_START_PAGE（データの生成を開始するページ）
    留置き帳票の手元出力用データの生成を開始するページ番号をIntegerオブジェクトで指定します。

    • 留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_PDF」を指定した場合
      1～ 99999999（最大8桁）の範囲で指定します。
          - 「0」を指定した場合は、1ページが指定されたとみなされます。
            ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した
            開始ページが有効になります。
          - 開始ページを指定しなかった場合は、「0」が指定されたとみなされます。

    • 留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_OWF」を指定した場合
      必ず「0」を指定してください（ページ範囲は指定できません）。

  • PARAM_END_PAGE（データの生成を終了するページ）
    留置き帳票の手元出力用データの生成を終了するページ番号をIntegerオブジェクトで指定します。省略した場合、「0」のIntegerオブジェクトが指定されたとみなされます。

    • 留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_PDF」を指定した場合
      1～ 99999999（最大8桁）の範囲で指定します。
          - 開始ページを指定した場合、その開始ページ以降のページ番号を指定します。
          - 「0」を指定した場合は、最終ページが指定されたとみなされます。
            ただし、帳票登録時にページ範囲を指定した場合、ユーザアプリケーションで指定した
            終了ページが有効になります。
          - 終了ページを指定しなかった場合は、「0」が指定されたとみなされます。

    • 留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_OWF」を指定した場合
      必ず「0」を指定してください（ページ範囲は指定できません）。

  • PARAM_WEBBROWSER_CLOSED（印刷終了後にWeb ブラウザを閉じる指定）
    留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_OWF」を指定した場合、留置き帳票の手元出力後にWebブラウザ画面を閉じるかどうかを、以下の値で指定できます。

    • OPTION_USE_APPLICATION（Webブラウザを自動的に閉じるかどうかは、帳票登録時の指定にしたがう）

    • OPTION_WEBBROWSER_CLOSED（Webブラウザを自動的に閉じる）

    • OPTION_WEBBROWSER_OPENED（Webブラウザを開いた状態にする）

    この値を省略した場合、「OPTION_USE_APPLICATION」が指定されたとみなされます。
    また、留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_OWF」以外を指定した場合、無効となります。

  • PARAM_PRINTDIALOG（印刷時の印刷画面の表示指定）
    留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_OWF」を指定した場合、留置き帳票の手元出力時に印刷時の印刷画面を表示するかどうかを、以下の値で指定します。

    • OPTION_USE_APPLICATION（印刷時の印刷画面の表示指定は、帳票登録時の指定にしたがう）

    • OPTION_PRINTDIALOG_DISABLE（印刷時の印刷画面を表示しない）

    • OPTION_PRINTDIALOG_OPEN（印刷時の印刷画面を表示する）

    この値を省略した場合、「OPTION_USE_APPLICATION」が指定されたとみなされます。
    また、留置き帳票の手元出力用データの種別に「OPTION_CONTENT_TYPE_OWF」以外を指定した場合、無効となります。

例外

OperateForm Exception：

留置き帳票の手元出力用データの生成処理でエラーが発生した場合

java.lang.Illegal ArgumentException：
java.lang.Illegal StateException：

セキュリティモード有効時において、ユーザがログイン状態ではない場合

セキュリティモードについては、以下を参照してください。

⇒“B.1 セキュリティモードの設定”

注意

備考

前次
Copyright 2012-2024 Fujitsu Limited