帳票印刷配信機能アプリケーション作成ガイド帳票管理編

Interstage List Works V10.1.0
帳票印刷配信機能
アプリケーション作成ガイド帳票管理編
Solaris
J2S0-0406-01Z0(00)
2012年10月
はじめに
本書は、List Works 帳票印刷配信機能(以降、List Managerと記します) が提供する帳票管理アプリケーション機能の詳細、および帳
票管理Java インタフェースを利用したアプリケーションの作成方法について記載しています。
なお、本文中の表記、対象読者と前提知識、商標、マニュアル体系、関連マニュアル、および本書の注意事項については、オンライ
ンマニュアル“帳票印刷配信機能マニュアル体系と読み方”を参照してください。
本書の構成
第1章帳票管理アプリケーション機能とは
帳票管理アプリケーション機能の概要と動作環境について説明します。
第2章帳票管理アプリケーション機能を使用してできること
帳票管理アプリケーション機能を使用してできることについて説明します。
第3章帳票管理Java インタフェース
帳票管理アプリケーション機能を使用するために利用する、帳票管理Java インタフェースについて説明します。
付録A 帳票管理Java インタフェースのサポート
帳票管理Java インタフェースのサポート状況について、他のインタフェースと比較して説明します。
付録B 起動オプション
セキュリティモードの設定方法やList Manager 管理データベースのデータベース接続プーリング数のカスタマイズ方法ついて説明
します。
・本書の内容は、改善のため事前連絡なしに変更することがあります。
・本書に記載されたデータの使用に起因する、第三者の特許権およびその他の権利の侵害については、当社はその責を負いませ
ん。
・無断転載を禁じます。
Microsoft Corporation のガイドラインに従って画面写真を使用しています。
Copyright 2012 FUJITSU LIMITED
-i-
目　次
第1章帳票管理アプリケーション機能とは...................................................................................................................................1
1.1 機能概要.............................................................................................................................................................................................1
1.2 動作環境.............................................................................................................................................................................................1
第2章帳票管理アプリケーション機能を使用してできること..........................................................................................................2
2.1 提供する機能......................................................................................................................................................................................2
2.2 取得/変更/検索条件として指定できる情報........................................................................................................................................3
2.3 帳票の出力状態と帳票の操作の関係...............................................................................................................................................6
第3章帳票管理Javaインタフェース............................................................................................................................................9
3.1 開発環境.............................................................................................................................................................................................9
3.1.1 モジュール構成............................................................................................................................................................................9
3.1.2 Javaパッケージ名.........................................................................................................................................................................9
3.2 帳票管理アプリケーション実行時に設定する環境変数....................................................................................................................9
3.2.1 Symfowareの場合........................................................................................................................................................................9
3.2.2 Oracleの場合..............................................................................................................................................................................11
3.3 帳票管理アプリケーションの開発.....................................................................................................................................................15
3.3.1 帳票管理アプリケーションの作成手順と記述例.......................................................................................................................15
3.3.2 アプリケーションのコンパイル・実行..........................................................................................................................................20
3.4 帳票管理Javaインタフェースで指定できる文字...............................................................................................................................20
3.5 クラス一覧..........................................................................................................................................................................................21
3.6 クラスの詳細（ユーザ関連）...............................................................................................................................................................22
3.6.1 UserAuthorizationクラス.............................................................................................................................................................23
3.6.1.1 メソッドの概要......................................................................................................................................................................23
3.6.1.2 メソッドの詳細......................................................................................................................................................................23
3.6.2 LMUserクラス..............................................................................................................................................................................25
3.6.2.1 メソッドの概要......................................................................................................................................................................25
3.6.2.2 メソッドの詳細......................................................................................................................................................................26
3.6.3 LMUserInfoクラス.......................................................................................................................................................................31
3.6.3.1 メソッドの概要......................................................................................................................................................................32
3.6.3.2 メソッドの詳細......................................................................................................................................................................33
3.6.4 LMUserManagerクラス...............................................................................................................................................................42
3.6.4.1 メソッドの概要......................................................................................................................................................................43
3.6.4.2 メソッドの詳細......................................................................................................................................................................43
3.6.5 LMUserGroupクラス...................................................................................................................................................................47
3.6.5.1 メソッドの概要......................................................................................................................................................................47
3.6.5.2 メソッドの詳細......................................................................................................................................................................47
3.6.6 LMNameクラス............................................................................................................................................................................48
3.6.6.1 メソッドの概要......................................................................................................................................................................48
3.6.6.2 メソッドの詳細......................................................................................................................................................................48
3.7 クラスの詳細（論理あて先関連）.......................................................................................................................................................49
3.7.1 LogicalDestinationManagerクラス..............................................................................................................................................49
3.7.1.1 コンストラクタの概要............................................................................................................................................................49
3.7.1.2 メソッドの概要......................................................................................................................................................................50
3.7.1.3 コンストラクタの詳細............................................................................................................................................................50
3.7.1.4 メソッドの詳細......................................................................................................................................................................50
3.7.2 LogicalDestinationクラス............................................................................................................................................................55
3.7.2.1 フィールドの概要.................................................................................................................................................................55
3.7.2.2 メソッドの概要......................................................................................................................................................................56
3.7.2.3 メソッドの詳細......................................................................................................................................................................58
3.7.3 LogicalDestinationFilterConditionクラス....................................................................................................................................79
3.7.3.1 フィールドの概要.................................................................................................................................................................79
3.7.3.2 コンストラクタの概要............................................................................................................................................................80
3.7.3.3 メソッドの概要......................................................................................................................................................................80
3.7.3.4 コンストラクタの詳細............................................................................................................................................................82
- ii -
3.7.3.5 メソッドの詳細......................................................................................................................................................................82
3.8 クラスの詳細（論理デバイス関連）....................................................................................................................................................90
3.8.1 LogicalDeviceManagerクラス.....................................................................................................................................................90
3.8.1.1 コンストラクタの概要............................................................................................................................................................90
3.8.1.2 メソッドの概要......................................................................................................................................................................90
3.8.1.3 コンストラクタの詳細............................................................................................................................................................90
3.8.1.4 メソッドの詳細......................................................................................................................................................................91
3.8.2 LogicalDeviceクラス....................................................................................................................................................................93
3.8.2.1 フィールドの概要.................................................................................................................................................................93
3.8.2.2 メソッドの概要......................................................................................................................................................................94
3.8.2.3 メソッドの詳細......................................................................................................................................................................95
3.8.3 LogicalDeviceFilterConditionクラス......................................................................................................................................... 101
3.8.3.1 コンストラクタの概要..........................................................................................................................................................102
3.8.3.2 メソッドの概要....................................................................................................................................................................102
3.8.3.3 コンストラクタの詳細..........................................................................................................................................................104
3.8.3.4 メソッドの詳細....................................................................................................................................................................104
3.9 クラスの詳細（帳票関連）................................................................................................................................................................111
3.9.1 FormManagerクラス..................................................................................................................................................................111
3.9.1.1 コンストラクタの概要..........................................................................................................................................................112
3.9.1.2 メソッドの概要....................................................................................................................................................................112
3.9.1.3 コンストラクタの詳細..........................................................................................................................................................113
3.9.1.4 メソッドの詳細....................................................................................................................................................................113
3.9.2 Formクラス................................................................................................................................................................................123
3.9.2.1 フィールドの概要...............................................................................................................................................................123
3.9.2.2 メソッドの概要....................................................................................................................................................................124
3.9.2.3 メソッドの詳細....................................................................................................................................................................128
3.9.3 FormFilterConditionクラス........................................................................................................................................................171
3.9.3.1 コンストラクタの概要..........................................................................................................................................................172
3.9.3.2 メソッドの概要....................................................................................................................................................................172
3.9.3.3 コンストラクタの詳細..........................................................................................................................................................175
3.9.3.4 メソッドの詳細....................................................................................................................................................................175
3.10 クラスの詳細（ソート指定）............................................................................................................................................................. 192
3.10.1 SortOrderクラス.......................................................................................................................................................................192
3.10.1.1 フィールドの概要.............................................................................................................................................................195
3.10.1.2 コンストラクタの概要........................................................................................................................................................196
3.10.1.3 メソッドの概要..................................................................................................................................................................196
3.10.1.4 コンストラクタの詳細........................................................................................................................................................196
3.10.1.5 メソッドの詳細..................................................................................................................................................................197
3.11 クラスの詳細（一覧取得）..............................................................................................................................................................198
3.11.1 ListResultクラス.......................................................................................................................................................................198
3.11.1.1 メソッドの概要..................................................................................................................................................................199
3.11.1.2 メソッドの詳細..................................................................................................................................................................199
3.12 クラスの詳細（パラメータ関連）......................................................................................................................................................200
3.12.1 LMParameterKeyクラス..........................................................................................................................................................200
3.12.1.1 フィールドの概要.............................................................................................................................................................200
3.12.2 LMParameterクラス................................................................................................................................................................. 202
3.12.2.1 コンストラクタの概要........................................................................................................................................................202
3.12.2.2 メソッドの概要..................................................................................................................................................................203
3.12.2.3 コンストラクタの詳細........................................................................................................................................................203
3.12.2.4 メソッドの詳細..................................................................................................................................................................204
3.12.3 LMParametersListクラス.........................................................................................................................................................205
3.12.3.1 コンストラクタの概要........................................................................................................................................................205
3.12.3.2 メソッドの概要..................................................................................................................................................................205
3.12.3.3 コンストラクタの詳細........................................................................................................................................................206
3.12.3.4 メソッドの詳細..................................................................................................................................................................206
3.13 例外クラスの詳細..........................................................................................................................................................................209
3.13.1 OperateExceptionクラス..........................................................................................................................................................209
- iii -
3.13.1.1 コンストラクタの概要........................................................................................................................................................209
3.13.1.2 メソッドの概要..................................................................................................................................................................209
3.13.1.3 コンストラクタの詳細........................................................................................................................................................210
3.13.1.4 メソッドの詳細..................................................................................................................................................................210
3.13.2 OperateFormExceptionクラス..................................................................................................................................................211
3.13.2.1 コンストラクタの概要........................................................................................................................................................212
3.13.2.2 メソッドの概要..................................................................................................................................................................212
3.13.2.3 コンストラクタの詳細........................................................................................................................................................212
3.13.2.4 メソッドの詳細..................................................................................................................................................................212
3.13.3 OperateAllFormsExceptionクラス...........................................................................................................................................213
3.13.3.1 コンストラクタの概要........................................................................................................................................................213
3.13.3.2 メソッドの概要..................................................................................................................................................................213
3.13.3.3 コンストラクタの詳細........................................................................................................................................................214
3.13.3.4 メソッドの詳細..................................................................................................................................................................214
3.14 注意事項.......................................................................................................................................................................................215
付録A 帳票管理Javaインタフェースのサポート範囲................................................................................................................220
A.1 帳票管理Javaインタフェースのサポート範囲................................................................................................................................220
付録B 起動オプション.............................................................................................................................................................222
B.1 セキュリティモードの設定...............................................................................................................................................................222
索引......................................................................................................................................................................................223
- iv -
第1章帳票管理アプリケーション機能とは
ここでは、List Managerが提供する帳票管理アプリケーション機能の概要と動作環境について説明します。
1.1 機能概要
List Managerでは、List Managerで管理している情報を取得・操作するアプリケーションの開発のためのJavaクラスライブラリとして帳票
管理Javaインタフェースを提供しています。
帳票管理アプリケーション機能とは、帳票管理Javaインタフェースを使用して、List Managerで管理している情報を取得・操作する帳票
管理アプリケーションを開発するための機能です。
帳票管理Javaインタフェースを使用して作成したアプリケーションは、「帳票管理アプリケーション」といいます。帳票管理Javaインタ
フェースでお客様のニーズに合わせたアプリケーションを自由に作成できます。
帳票管理アプリケーション機能がサポートしている機能については、以下を参照してください。
⇒“第2章帳票管理アプリケーション機能を使用してできること”
さらに、帳票管理アプリケーションの動作モードをセキュリティモードにすることで、セキュリティ強化ができます。設定方法については、
以下を参照してください。
⇒“B.1 セキュリティモードの設定”
1.2 動作環境
帳票管理アプリケーションは、帳票管理サーバ上の以下の環境で動作します。
動作オペレーティングシステム
以下のいずれかのオペレーティングシステムで動作します。
・ Solaris 9
・ Solaris 10
・ Solaris 11
必要なList Worksの種類
以下のいずれかのList Worksが必要です。
・ List Works Standard Edition
・ List Works Enterprise Edition
-1-
第2章帳票管理アプリケーション機能を使用してできること
ここでは、帳票管理アプリケーション機能を使用してできることについて説明します。
2.1 提供する機能
以下に、帳票管理Javaインタフェースが提供する機能について、操作の対象となる情報別に示します。
分類
ユーザ情報
操作
ユーザの認証
ユーザ一覧（ユーザID、ユーザ名）の取得
ユーザの検索
ユーザ情報の取得
ユーザごとの帳票管理情報
以下の情報の変更
・取得した帳票一覧の自動更新
・取得した帳票一覧の自動更新間隔
・帳票の絞り込み条件の保存
・帳票の絞り込み条件
・論理あて先の絞り込み条件の保存
・論理あて先の絞り込み条件
・帳票を一覧取得する場合の最大取得帳票数
・帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表
示
・応答メッセージを表示させる論理あて先名(*1)
ユーザグループ情報
ユーザグループ一覧（ユーザグループID、ユーザグループ名）の取得
ユーザグループの検索
論理あて先情報
論理あて先一覧の取得
論理あて先の検索
論理あて先の起動/停止
論理あて先の出力先（論理デバイス）の切り替え
論理デバイス情報
論理デバイス一覧の取得
論理デバイスの検索
帳票属性
帳票一覧の取得
帳票の検索
帳票の出力
帳票のプレビュー用データの生成
帳票の出力中止
帳票の出力の強制中止
帳票の応答待ちへの応答
帳票の削除
帳票の複写
帳票の移動
-2-
分類
操作
帳票の一括保留解除
帳票の一括出力中止
帳票の出力の一括強制中止
帳票の一括削除
帳票の一括複写
帳票情報の更新
留置き帳票の手元出力用データの生成
*1：
帳票管理Javaインタフェースでは、応答メッセージの表示/非表示をユーザ単位に設定し、その情報を取得できる機能を提供して
います。
2.2 取得/変更/検索条件として指定できる情報
帳票管理アプリケーション機能では、List Managerで管理されているユーザ情報、ユーザごとの帳票管理情報、ユーザグループ情報、
論理あて先情報、論理デバイス情報、および帳票属性の値を取得/変更することができます。
ここでは、これらについて取得/変更に指定できる情報、および取得時に検索条件として指定できる情報を示します。
●ユーザ情報の場合
帳票管理アプリケーション機能を使用して取得/検索条件として指定できるユーザ情報は、以下のとおりです。
なお、ユーザ情報の変更はできません。
ユーザ情報
取得
検索条件
として指定
ユーザID
○
○
ユーザ名（フルネーム）
○
×
ユーザ名（姓）
○
×
コメント
○
×
ユーザグループID
○
×
○：可能
×：不可
●ユーザごとの帳票管理情報の場合
帳票管理アプリケーション機能を使用して取得/変更できるユーザごとの帳票管理情報は、以下のとおりです。
なお、ユーザごとの帳票管理情報は、検索時の検索条件として指定することはできません。
ユーザごとの帳票管理情報
取得
変更
取得した帳票一覧の自動更新
○
○
取得した帳票一覧の自動更新間隔
○
○
最後に帳票を取得/検索した論理あて先名
○
×
帳票の絞り込み条件の保存
○
○
帳票の絞り込み条件
○
○
論理あて先の絞り込み条件の保存
○
○
論理あて先の絞り込み条件
○
○
-3-
ユーザごとの帳票管理情報
取得
変更
帳票を一覧取得する場合の最大取得帳票数
○
○
帳票の一覧取得時に、応答待ちが発生した帳票の
応答メッセージの表示/非表示
○
○
応答メッセージを表示させる論理あて先名
○
○
○：可能
×：不可
●ユーザグループ情報の場合
帳票管理アプリケーション機能を使用して取得/検索条件として指定できるユーザグループ情報は、以下のとおりです。
なお、ユーザグループ情報の変更はできません。
ユーザグループ情報
取得
検索条件
として指定
ユーザグループID
○
○
ユーザグループ名
○
×
コメント
○
×
○：可能
×：不可
●論理あて先情報の場合
帳票管理アプリケーション機能を使用して取得/検索条件として指定できる論理あて先情報は、以下のとおりです。
なお、論理あて先情報の変更はできません。
論理あて先情報
取得
検索条件
として指定
論理あて先名
○
○
コメント
○
×
論理あて先タイプ
○
○
優先度
○
○
論理デバイス名
○
○
コメント（出力先）
○
○
論理あて先の状態
○
○
帳票作成後の出力指定
○
×
帳票出力後の保存指定
○
×
保存日数の指定
○
×
カスタマイズ項目1～5
○
○
出力エラー状態
○
○
出力方法
○
○
○：可能
×：不可
-4-
●論理デバイス情報の場合
帳票管理アプリケーション機能を使用して取得/検索条件として指定できる論理デバイス情報は、以下のとおりです。
なお、論理デバイス情報の変更はできません。
論理デバイス情報
取得
検索条件
として指定
論理デバイス名
○
○
出力方法
○
○
通信対象コンピュータ名
○
○
印刷プリンタ名
○
×
出力フォルダ
○
×
電子保存時の保管フォルダパス名(*1)
○
×
原点位置指定単位
○
×
原点位置縦方向（ミリ単位）
○
×
原点位置横方向（ミリ単位）
○
×
原点位置縦方向（インチ単位）
○
×
原点位置横方向（インチ単位）
○
×
コメント（出力先）
○
○
論理デバイス区分
○
○
用紙交換メッセージ表示指定(*2)
○
×
メッセージ通知先(*2)
○
×
PDF文書情報ファイル名(*2)
○
×
FAX配信属性ファイル名(*2)
○
×
カスタマイズ項目1～8
○
○
○：可能
×：不可
*1：
本論理デバイス情報は、Interstage List Manager互換のための機能で使用します。
*2：
ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
●帳票属性の場合
帳票管理アプリケーション機能を使用して取得/変更できる帳票属性、検索条件として指定できる帳票属性は、以下のとおりです。
帳票属性
取得
検索条件
として指定
変更
論理あて先名
○
○
×
帳票データファイル名
○
×
×
帳票ID
○
○
×
配信通番
○
×
×
コネクタ通番
○
×
×
コネクタ通番2
○
×
×
-5-
帳票属性
取得
検索条件
として指定
変更
コネクタ通番3
○
×
×
ユーザアプリケーション種別
○
×
×
ユーザアプリケーションを実行する帳票管理サーバ
○
×
×
依頼元端末
○
○
×
作成ユーザ
○
○
×
作成日時
○
○
×
出力完了
○
○
×
出力ページ数
○
×
×
帳票の総ページ数
○
×
×
帳票名
○
○
×
タイトル
○
○
×
コメント
○
○
×
帳票作成後の出力指定
○
×
×
帳票出力後の保存指定
○
×
×
保存期限（帳票を保存する期間の終点の日付）
○
○
×
印刷部数
○
×
×
用紙コード
○
×
×
カスタマイズ項目1～13
○
○
○
出力状態
○
○
×
出力完了ページ数
○
×
×
エラーメッセージの送信元
○
×
×
エラーメッセージ番号
○
×
×
エラー詳細コード
○
×
×
エラー詳細メッセージ
○
×
×
ファイル拡張子
○
×
×
MIMEタイプ
○
×
×
業務あて先
○
○
○
最終出力者ID
○
○
×
出力依頼日時
○
○
×
出力回数
○
×
×
プレビュー回数
○
×
×
○：可能
×：不可
2.3 帳票の出力状態と帳票の操作の関係
帳票に対する操作を行う場合、帳票の出力状態によって、行える操作と行えない操作があります。
以下に、帳票の出力状態と、帳票の操作の関係について示します。
●帳票の出力状態と帳票の操作の関係
-6-
帳票の出力状態
説明
帳票の操作(*2)
帳票の帳票の留置き帳票の帳票の帳票の帳票の帳票の帳票の
出力
プレ
帳票の複写
移動出力中削除応答待出力の
ビュー手元出
止(*3)
ちへの強制中
(*4)
用デー力用
応答
止(*3)
タの
データ
生成の生成
(*1)
失敗
STATUS_
FAILED
配信処理中に続行不可
能なエラーが発生して終
了した状態です。
○
○
○
○
○
×
○
×
×
接続エラー
STATUS_
CONNECT_
ERROR
帳票管理サーバから帳
票出力サーバへの配信
依頼がタイムアウトした状
態です。
×
○
○
○
○
○
×
×
○
出力エラー
STATUS_
OUTPUT_
ERROR(*5)(*6)
オフライン、用紙切れな
どプリンタ装置でエラー
が発生した状態です。
×
○
○
○
×
○
(*7)
×
×
○
応答待ち
STATUS_
WAIT_
REPLY(*5)(*6)
用紙交換の指示が発生
した状態、または出力開
始の通知が発生した状
態です。
×
○
○
○
×
○
(*7)
×
○(*7)
○
出力中
STATUS_
OUTPUTTING
(*5)(*6)
帳票出力サーバで帳票
の出力処理が行われて
いる状態です。
×
○
○
○
×
○
(*7)
×
×
○
出力待ち
STATUS_
PENDING(*5)
(*6)
帳票出力サーバで帳票
の出力を待ち合わせて
いる状態です。
×
○
○
○
×
○
(*7)
×
×
○
出力保留
STATUS_
SUSPENDED
(*5)(*6)
帳票出力サーバで帳票
の出力が保留されている
状態です。
○
○
○
○
×
○
(*7)
×
×
○
配信中
STATUS_
SENDING
帳票管理サーバで帳票
の配信処理が行われて
いる状態です。
×
○
○
○
×
○(*7)
(*8)
×
×
○
配信待ち
STATUS_
WAIT_SEND
帳票管理サーバで帳票
の配信を待ち合わせて
いる状態です。
×
○
○
○
×
○
(*7)
×
×
○
配信依頼
STATUS_
REQUIRED
帳票の出力依頼が帳票
管理サーバに登録され
た状態です。
×
○
○
○
○
○
×
×
○
登録
STATUS_
CREATED
帳票の登録が完了した
状態です。
○
○
○
○
○
×
○
×
×
中止
STATUS_
CANCELED
帳票の出力を中止して
終了した状態です。
○
○
○
○
○
×
○
×
×
出力済
STATUS_
FINISHED
帳票出力サーバで帳票
の出力処理が完了した
状態です。
○
○
○
○
○
×
○
×
×
-7-
○：操作可能
×：操作不可
*1：
「帳票の出力状態」の列の見方について、1行目の項目を例に挙げて説明します。
失敗：
帳票の出力状態
STATUS_FAILED：
FormクラスのgetOutputStatusメソッドで取得されるフィールド
*2：
行えない操作を行った場合に、例外（OperateFormException）が発生します。
*3：
論理あて先の論理あて先タイプがWeb 手元印刷用の場合、操作できません。
*4：
保存期限を経過した帳票の削除を行う場合、保存期限を経過した帳票の削除コマンド（lmdelexpire コマンド）を使用します。詳細
は、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“6.2.4.3 lmdelexpireコマンド”を参照してください。
*5：
論理デバイスの出力方法が以下の場合、この出力状態には遷移しません。
・帳票配信型の場合のList Works（電子保存(Interstage List Manager互換のための機能)）
・帳票配信型の場合のPDF（PDFファイル保存）
*6：
帳票がスプール中の場合、スプールが完了してから操作を行います。
*7：
帳票出力サーバと通信できない場合、帳票の操作がエラーとなる場合があります。
*8：
論理デバイスの出力方法が以下の場合、操作できません。
・帳票配信型の場合のList Works（電子保存(Interstage List Manager互換のための機能)）
・帳票配信型の場合のPDF（PDFファイル保存）
-8-
第3章帳票管理Javaインタフェース
ここでは、帳票管理アプリケーション機能で利用する「帳票管理Javaインタフェース」について説明します。
3.1 開発環境
3.1.1 モジュール構成
List Managerでは、帳票管理アプリケーションから帳票の情報を取得/操作するためのインタフェースとして、帳票管理Javaインタフェー
スを提供しています。
帳票管理Javaインタフェースは、以下の構成となっています。
種類
Jarファイル
名前
f3hxcopr.jar
格納ディレクトリ
/opt/FJSVlstm/classes
f3hxcjop.jar
3.1.2 Javaパッケージ名
帳票管理Javaインタフェースが提供するインタフェースには、以下のパッケージがあります。
com.fujitsu.listmanager.operate
3.2 帳票管理アプリケーション実行時に設定する環境変数
帳票管理アプリケーション実行時に帳票管理サーバで設定する環境変数について説明します。
環境変数の説明は、List Manager管理データベースに使用する以下のデータベース別に示します。
・ Symfoware
・ Oracle
帳票管理アプリケーションは、環境変数の設定後に実行してください。
帳票管理アプリケーションのプログラムのコンパイルおよびJavaコマンドでの実行については、以下を参照してください。
⇒“3.3.2 アプリケーションのコンパイル・実行”
3.2.1 Symfowareの場合
List Manager管理データベースにSymfowareを使用する場合の環境変数について説明します。
帳票管理アプリケーション実行時に、帳票管理サーバで以下の環境変数を設定してください。
注意
帳票管理アプリケーション実行時に、以下の環境変数の設定を行わないでください。
LC_*
(“LC_”から始まる環境変数)
環境変数
LD_LIBRARY_PATH
（必須）
指定値
「/opt/FSUNrdb2b/lib」を追加します。
「/opt/FJSVlstm/lib」を追加します。
「/opt/FJSVoast/lib」を追加します。
「/opt/FJSVoastw/lib」を追加します。
-9-
環境変数
指定値
「/etc/opt/FSUNiconv/lib」（Charset Managerを使用する場合）を追加します。
帳票管理Javaアプリケーションの実行環境の文字コード系を指定します。
LANG
（必須）
以下に、指定できる値を示します。
ja_JP.PCK：
Shift-JISコード系
ja_JP.UTF-8：
UNICODE（UTF8）コード系
ここで指定する文字コード系は、帳票管理サーバの環境設定ファイルのDBCharCode
キーで設定した文字コード系と合致させてください。
帳票管理サーバとList Manager管理データベースを同一マシンで運用する場合、
「lmrdbsys」を指定します。
RDBNAME
帳票管理サーバとList Manager管理データベースを別マシンで運用する場合、指定す
る必要はありません。
以下を指定します。
SQLRTENV
・「/etc/opt/FJSVlstm/lmsqlenvc」
●LD_LIBRARY_PATH（必須）
環境変数LD_LIBRARY_PATHは、必ず設定します。
この環境変数には、以下の値を指定してください。
・ Symfowareライブラリ格納フォルダ
「/opt/FSUNrdb2b/lib」
・ List Managerのライブラリ格納フォルダ
「/opt/FJSVlstm/lib」、「/opt/FJSVoast/lib」、および「/opt/FJSVoastw/lib」
・ Symfowareで使用する標準コード変換のライブラリ格納フォルダ（Charset Managerの機能を使用する場合）
「/etc/opt/FSUNiconv/lib」
例：Bourne シェルを使用して環境変数LD_LIBRARY_PATHを指定する場合
LD_LIBRARY_PATH=/opt/FSUNrdb2b/lib:/opt/FJSVlstm/lib:/opt/FJSVoast/lib:/opt/FJSVoastw/
lib:$LD_LIBRARY_PATH
export LD_LIBRARY_PATH
●LANG（必須）
環境変数LANGは、必ず設定します。
この環境変数には、帳票管理Javaアプリケーションの実行環境の文字コード系を指定します。
ここで指定する文字コード系は、帳票管理サーバの環境設定ファイルのDBCharCode キーで設定した文字コード系と合致させてくだ
さい。
指定できる値
説明
ja_JP.PCK
帳票管理Javaアプリケーションの実行環境の文字コード系がShift-JISコード系の場合に指
定します。
ja_JP.UTF-8
帳票管理Javaアプリケーションの実行環境の文字コード系がUNICODE（UTF8）コード系の
場合に指定します。
- 10 -
注意
上記以外の値、または帳票管理サーバの環境設定ファイルのDBCharCode キーで設定した文字コード系と異なる値を指定した場合、
帳票出力時に日本語が正しく表示されません。
例：Bourne シェルを使用して環境変数LANGを指定する場合
Shift-JISコード系の場合
LANG=ja_JP.PCK
export LANG
UNICODE（UTF8）コード系の場合
LANG=ja_JP.UTF-8
export LANG
●RDBNAME（帳票管理サーバとList Manager管理データベースを同一マシンで運用する場合のみ必須）
帳票管理サーバとList Manager管理データベースを同一マシンで運用する場合、必ず環境変数RDBNAMEを設定します。
帳票管理サーバとList Manager管理データベースを別マシンで運用する場合、この環境変数の設定は不要です。
この環境変数には、「lmrdbsys」を指定してください。
例：Bourne シェルを使用して環境変数RDBNAMEを指定する場合
RDBNAME=lmrdbsys
export RDBNAME
●SQLRTENV（必須）
環境変数SQLRTENVは、必ず設定します。
この環境変数には、以下の値を指定してください。
/etc/opt/FJSVlstm/lmsqlenvc
例：Bourne シェルを使用して環境変数SQLRTENVを指定する場合
SQLRTENV=/etc/opt/FJSVlstm/lmsqlenvc
export SQLRTENV
3.2.2 Oracleの場合
List Manager管理データベースにOracleを使用する場合の環境変数について説明します。
帳票管理アプリケーション実行時に、帳票管理サーバで以下の環境変数を設定してください。
注意
帳票管理アプリケーション実行時に、以下の環境変数の設定を行わないでください。
LC_*
(“LC_”から始まる環境変数)
環境変数
ORACLE_HOME
指定値
帳票管理サーバとList Manager管理データベースのデータベースサーバが同じサーバ
の場合
・ Oracleが10gR2または11gR1の場合
「Oracleをインストールしたディレクトリ」を指定します。
- 11 -
環境変数
指定値
・ Oracleが11gR2の場合
「Oracle Client(32bit)をインストールしたディレクトリ」を指定します。
帳票管理サーバとList Manager管理データベースのデータベースサーバが異なるサー
バの場合
・ Oracleが10gR2または11gR1の場合
「Oracle Clientをインストールしたディレクトリ」を指定します。
・ Oracleが11gR2の場合
「Oracle Client(32bit)をインストールしたディレクトリ」を指定します。
LD_LIBRARY_PATH
（必須）
・ Oracleが10gR2または11gR1の場合
「$ORACLE_HOME/lib32」を追加します。
・ Oracleが11gR2の場合
「Oracle Client(32bit)の$ORACLE_HOME/lib」を追加します。
「/opt/FJSVlstm/lib」を追加します。
「/opt/FJSVoast/lib」を追加します。
「/opt/FJSVoastw/lib」を追加します。
「/etc/opt/FSUNiconv/lib」（Charset Managerの機能を使用する場合）を追加します。
LANG
（必須）
帳票管理Javaアプリケーションの実行環境の文字コード系を指定します。
以下に、指定できる値を示します。
ja_JP.PCK：
Shift-JISコード系
ja (*1)：
EUCコード系
japanese (*1)：
EUCコード系
ja_JP.eucJP：
EUCコード系
ja_JP.UTF-8：
UNICODE（UTF8）コード系
ここで指定する文字コード系は、帳票管理サーバの環境設定ファイルのDBCharCode
キーで設定した文字コード系と合致させてください。
NLS_LANG
List Manager管理データベースの文字コード系を指定します。
以下に、指定できる値を示します。
Japanese_Japan.JA16SJIS：
Shift-JISコード系
Japanese_Japan.JA16SJISYEN：
Shift-JISコード系
Japanese_Japan.JA16SJISTILDE：
Shift-JISコード系
- 12 -
環境変数
指定値
Japanese_Japan.UTF8：
UNICODE（UTF8）コード系
Japanese_Japan.JA16EUC：
EUCコード系
Japanese_Japan.JA16EUCYEN：
EUCコード系
Japanese_Japan.JA16EUCTILDE：
EUCコード系
ここで指定する文字コード系は、帳票管理サーバの環境設定ファイルのDBCharCode
キーで設定した文字コード系と合致させてください。
*1：
Solaris11では指定できません。
●ORACLE_HOME（必須）
環境変数ORACLE_HOMEは、必ず設定します。
Oracleをインストールしたディレクトリを指定する環境変数です。
帳票管理サーバとList Manager管理データベースのデータベースサーバが同じサーバの場合は、OracleまたはOracle Clientをインス
トールしたディレクトリを指定します。
帳票管理サーバとList Manager管理データベースのデータベースサーバが異なるサーバの場合は、Oracle Clientをインストールした
ディレクトリを指定します。
例：Bourne シェルを使用して環境変数ORACLE_HOMEを指定する場合
ORACLE_HOME=Oracleをインストールしたディレクトリ
export ORACLE_HOME
●LD_LIBRARY_PATH（必須）
環境変数LD_LIBRARY_PATHは、必ず設定します。
この環境変数には、以下の値を指定してください。
・ Oracleライブラリ格納フォルダ
「$ORACLE_HOME/lib32」またはOracle Client(32bit)の「$ORACLE_HOME/lib」
・ List Managerのライブラリ格納フォルダ
「/opt/FJSVlstm/lib」、「/opt/FJSVoast/lib」、「/opt/FJSVoastw/lib」
・ Charset Managerのライブラリ格納フォルダ（Charset Managerの機能を使用する場合）
「/etc/opt/FSUNiconv/lib」
例：Bourne シェルを使用して環境変数LD_LIBRARY_PATHを指定する場合
Oracle 11gR2を使用する場合
LD_LIBRARY_PATH=$ORACLE_HOME/lib:/opt/FJSVlstm/lib:/opt/FJSVoast/lib:/opt/FJSVoastw/lib:$LD_LIBRARY_PATH
export LD_LIBRARY_PATH
Oracle 10gR2またはOracle 11gR1を使用する場合
LD_LIBRARY_PATH=$ORACLE_HOME/lib32:/opt/FJSVlstm/lib:/opt/FJSVoast/lib:/opt/FJSVoastw/lib:$LD_LIBRARY_PATH
export LD_LIBRARY_PATH
- 13 -
●LANG（必須）
環境変数LANGは、必ず設定します。
この環境変数には、帳票管理Javaアプリケーションの実行環境の文字コード系を指定します。
ここで指定する文字コード系は、帳票管理サーバの環境設定ファイルのDBCharCode キーで設定した文字コード系と合致させてくだ
さい。
指定できる値
説明
ja_JP.PCK
帳票管理Javaアプリケーションの実行環境の文字コード系がShift-JISコード系の場合に指
定します。
ja(*1)
帳票管理Javaアプリケーションの実行環境の文字コード系がEUCコード系の場合に指定し
ます。
japanese(*1)
ja_JP.eucJP
帳票管理Javaアプリケーションの実行環境の文字コード系がUNICODE（UTF8）コード系の
場合に指定します。
ja_JP.UTF-8
*1：
Solaris11では指定できません。
注意
上記以外の値、または帳票管理サーバの環境設定ファイルのDBCharCode キーで設定した文字コード系と異なる値を指定した場合、
帳票出力時に日本語が正しく表示されません。
例：Bourne シェルを使用して環境変数LANGを指定する場合
Shift-JISコード系の場合
LANG=ja_JP.PCK
export LANG
EUCコード系の場合
LANG=ja_JP.eucJP
export LANG
UNICODE（UTF8）コード系の場合
LANG=ja_JP.UTF-8
export LANG
●NLS_LANG（必須）
環境変数NLS_LANGは、必ず設定します。
この環境変数には、List Manager管理データベースの文字コードを指定します。ここで指定する文字コード系は、帳票管理サーバの
環境設定ファイルのDBCharCodeキーで設定した文字コード系と合致させてください。
指定できる値
Japanese_Japan.JA16SJIS
Japanese_Japan.JA16SJISYEN
説明
List Manager 管理データベースの文字コード系がShift-JISコード系の場
合に指定します。
Japanese_Japan.JA16SJISTILDE
Japanese_Japan.JA16EUC
Japanese_Japan.JA16EUCYEN
List Manager 管理データベースの文字コード系がEUCコード系の場合
に指定します。
Japanese_Japan.JA16EUCTILDE
- 14 -
指定できる値
Japanese_Japan.UTF8
説明
List Manager 管理データベースの文字コード系がUNICODE（UTF8）コー
ド系の場合に指定します。
注意
上記以外の値、または帳票管理サーバの環境設定ファイルのDBCharCodeキーで設定した文字コード系と異なる値を指定した場合、
帳票出力時に日本語が正しく表示されません。
例：Bourne シェルを使用して環境変数NLS_LANGを指定する場合
Shift-JISコード系の場合
NLS_LANG=Japanese_Japan.JA16SJIS
export NLS_LANG
EUCコード系の場合
NLS_LANG=Japanese_Japan.JA16EUC
export NLS_LANG
UNICODE（UTF8）コード系の場合
NLS_LANG=Japanese_Japan.UTF8
export NLS_LANG
3.3 帳票管理アプリケーションの開発
アプリケーションの作成手順と記述例について説明します。
3.3.1 帳票管理アプリケーションの作成手順と記述例
帳票管理Javaインタフェースを利用したアプリケーションの作成手順と記述例について、以下の場合に分けて説明します。
・論理あて先を取得/操作する場合
・帳票を取得/操作する場合
・ユーザを取得する場合
・ユーザグループを取得する場合
●論理あて先を取得/操作する場合
＜作成手順＞
1. List Managerのユーザ認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
2. LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します。
1.で取得したLMUserクラスのインスタンスオブジェクトを引数に渡し、LogicalDestinationManagerクラスのインスタンスオブジェク
トを生成します。
3. LogicalDestinationクラスを取得します。
LogicalDestinationManagerクラスのgetLogicalDestinationsメソッドを呼び出して、LogicalDestinationクラスのインスタンスオブジェ
クトの配列を取得します。
- 15 -
ポイント
－検索条件を指定して検索を行う場合は、LogicalDestinationFilterConditionクラスのインスタンスオブジェクトを生成し、検索
条件を設定したものをgetLogicalDestinationsメソッドの引数に渡します。
－取得した論理あて先のソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定し
たものをgetLogicalDestinationsメソッドの引数に渡します。
取得したLogicalDestinationクラスのインスタンスオブジェクトから論理あて先の情報を取得するには、LogicalDestinationクラスの
情報取得メソッド（getまたはisで始まるメソッド）で取得できます。
4. 論理あて先を操作します。
操作を行う論理あて先のLogicalDestinationクラスのメソッドを呼び出します。
＜記述例＞
論理あて先名が「ld1」の論理あて先を取得して、起動します。
import
import
import
import
import
com.fujitsu.listmanager.operate.LMUser;
com.fujitsu.listmanager.operate.LogicalDestination;
com.fujitsu.listmanager.operate.LogicalDestinationFilterCondition;
com.fujitsu.listmanager.operate.LogicalDestinationManager;
com.fujitsu.listmanager.operate.UserAuthorization;
:
:
// List Managerのユーザ認証を行います
//ユーザIDが「user1」、パスワードが「psw1」のユーザを取得します
LMUser user = UserAuthorization.authorize( "user1", "psw1" );
// LogicalDestinationManager クラスのインスタンスオブジェクトを生成します
LogicalDestinationManager logicalDestinationManager = new LogicalDestinationManager(user);
//論理あて先が「ld1」の論理あて先クラスを取得します
LogicalDestinationFilterCondition filter = new LogicalDestinationFilterCondition();
filter.setName( "ld1" );
LogicalDestination[] logicalDestinations = logicalDestinationManager.getLogicalDestinations
(filter,null);
LogicalDestination ld1 = logicalDestinations[0];
// LogicalDestinationクラスの情報を取得します
String name
= ld1.getName();
// 論理あて先名
String comment = ld1.getComment();
// コメント
int type
= ld1.getType();
// 論理あて先タイプ
String device = ld1.getDeviceName(); // 論理デバイス名
boolean active = ld1.isActive();
// 論理あて先の状態
:
:
//論理あて先を起動します
ld1.start();
:
:
●帳票を取得/操作する場合
＜作成手順＞
1. List Managerのユーザ認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
- 16 -
2. LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します。
1.で取得したLMUserクラスのインスタンスオブジェクトを引数に渡し、LogicalDestinationManagerクラスのインスタンスオブジェク
トを生成します。
3. LogicalDestinationクラスを取得します。
LogicalDestinationManagerクラスのgetLogicalDestinationsメソッドを呼び出して、
LogicalDestinationクラスのインスタンスオブジェクトの配列を取得します。
ポイント
－検索条件を指定して検索を行う場合は、LogicalDestinationFilterConditionクラスのインスタンスオブジェクトを生成し、検索
条件を設定したものをgetLogicalDestinationsメソッドの引数に渡します。
－取得した論理あて先のソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定し
たものをgetLogicalDestinationsメソッドの引数に渡します。
4. Formクラスを取得します。
LogicalDestinationクラスのgetFormsメソッドを呼び出して、Formクラスのインスタンスオブジェクトの配列を取得します。
取得する帳票の帳票IDが分かる場合は、LogicalDestinationクラスのgetFormメソッドを呼び出して、Formクラスのインスタンスオ
ブジェクトを取得します。
ポイント
－検索条件を指定して検索を行う場合は、FormFilterConditionクラスのインスタンスオブジェクトを生成し、検索条件を設定し
たものをgetFormsメソッドの引数に渡します。
－取得した帳票のソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したもの
をgetFormsメソッドの引数に渡します。
取得したFormクラスのインスタンスオブジェクトから帳票属性を取得するには、Formクラスの情報取得メソッド（getまたはisで始ま
るメソッド）で取得できます。
5. 帳票を操作します。
操作する帳票のFormクラスのメソッドを呼び出します。
＜記述例＞
出力状態が「失敗」（STATUS_FAILED）の帳票を取得して、削除します。
import
import
import
import
import
import
import
import
:
:
com.fujitsu.listmanager.operate.LMUser;
com.fujitsu.listmanager.operate.LogicalDestination;
com.fujitsu.listmanager.operate.LogicalDestinationFilterCondition;
com.fujitsu.listmanager.operate.LogicalDestinationManager;
com.fujitsu.listmanager.operate.UserAuthorization;
com.fujitsu.listmanager.operate.Form;
com.fujitsu.listmanager.operate.FormFilterCondition;
com.fujitsu.listmanager.operate.SortOrder;
// List Manager のユーザ認証を行います
//ユーザIDが「user1」、パスワードが「psw1」のユーザを取得します
LMUser user = UserAuthorization.authorize("user1", "psw1");
// LogicalDestinationManagerクラスのインスタンスオブジェクトを生成します
LogicalDestinationManager logicalDestinationManager = new LogicalDestinationManager(user);
// 論理あて先が「ld1」のLogicalDestinationクラスを取得します
LogicalDestinationFilterCondition filter = new LogicalDestinationFilterCondition();
filter.setName("ld1");
LogicalDestination[] logicalDestinations = logicalDestinationManager.getLogicalDestinations
- 17 -
(filter,null);
LogicalDestination ld1 = logicalDestinations[0];
// 論理あて先から、出力状態が「失敗」の帳票を取得します（取得した帳票は、帳票ID、帳票名の順で
ソートします）
FormFilterCondition formFilter = new FormFilterCondition();
int[] outputStatus = {Form.STATUS_FAILED};
formFilter.setOutputStatus(outputStatus);
SortOrder[] sort = {new SortOrder(SortOrder.ITEM_FORM_ID),
new SortOrder(SortOrder.ITEM_FORM_NAME)}
Form[] forms = ld1.getForms(formFilter, sort);
// 帳票を削除します
for (int i = 0; i < forms.length; i++) {
forms[i].delete();
}
:
:
●ユーザを取得する場合
＜作成手順＞
1. List Managerユーザの認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
ここでは、List Managerの管理者権限で認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
2. LMUserManagerクラスを取得します。
1.で取得したLMUserクラスのインスタンスオブジェクトをキャストして、LMUserManagerクラスのインスタンスオブジェクトを取得し
ます。
3. ユーザを取得します。
LMUserManagerクラスのgetUsersメソッドを呼び出し、LMUserクラスのインスタンスオブジェクトの配列を取得します。
ポイント
取得したユーザのソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定したものを
getUsersメソッドの引数に渡します。
取得したLMUserクラスのインスタンスオブジェクトからユーザ情報を取得するには、LMUserクラスの情報取得メソッド（getで始ま
るメソッド）で取得できます。
＜記述例＞
ユーザIDが「userid1」のユーザを取得します。
import com.fujitsu.listmanager.operate.LMUser;
import com.fujitsu.listmanager.operate.LMUserManager;
import com.fujitsu.listmanager.operate.UserAuthorization;
:
:
// List Managerの管理者権限で、認証を行います
LMUser user = UserAuthorization.authorize("admin1","adpsw1");
//LMUserManagerクラスを取得します
LMUserManager manager = null;
if (user instanceof LMUserManager) {
manager = (LMUserManager)user;
}
//ユーザIDが「userid1」のユーザを取得します
- 18 -
LMUser[] users = manager.getUsers("userid1", null, null);
LMUser user1 = users[0];
//ユーザの情報を取得します。
String fullname = user1.getFullName(); //フルネーム
String comment = user1.getComment();
//コメント
:
:
●ユーザグループを取得する場合
＜作成手順＞
1. List Managerユーザの認証を行います。
UserAuthorizationクラスのauthorizeメソッドを呼び出して、ユーザ情報で定義されたユーザで、ユーザ認証を行います。
ここでは、List Managerの管理者権限で認証を行います。
認証に成功すると、LMUserクラスのインスタンスオブジェクトが取得されます。
2. LMUserManagerクラスを取得します。
1.で取得したLMUserクラスのインスタンスオブジェクトをキャストして、LMUserManagerクラスのインスタンスオブジェクトを取得し
ます。
3. ユーザグループを取得します。
LMUserManagerクラスのgetUserGroupsメソッドを呼び出し、LMUserGroupクラスのインスタンスオブジェクトの配列を取得しま
す。
ポイント
取得したユーザグループのソート順を指定する場合は、SortOrderクラスのインスタンスオブジェクトを生成し、ソート項目を指定
したものをgetUserGroupsメソッドの引数に渡します。
取得したLMUserGroupクラスのインスタンスオブジェクトからユーザグループ情報を取得するには、LMUserGroupクラスの情報
取得メソッド（getで始まるメソッド）で取得できます。
＜記述例＞
ユーザグループIDが「usergroupid1」のユーザを取得します。
import
import
import
import
:
:
com.fujitsu.listmanager.operate.LMUser;
com.fujitsu.listmanager.operate.LMUserGroup;
com.fujitsu.listmanager.operate.LMUserManager;
com.fujitsu.listmanager.operate.UserAuthorization;
// List Managerの管理者権限で、認証を行います
LMUser user = UserAuthorization.authorize("admin1","adpsw1");
//LMUserManagerクラスを取得します
LMUserManager manager = null;
if (user instanceof LMUserManager) {
manager = (LMUserManager)user;
}
//ユーザグループID が「usergroupid1」のユーザを取得します
LMUserGroup[] userGroups = manager.getUserGroups("usergroupid1",null);
LMUserGroup userGroup1 = userGroups[0];
//ユーザグループの情報を取得します。
String groupName = userGroup1.getGroupName(); //ユーザグループ名
String comment = userGroup1.getComment();
//コメント
- 19 -
:
:
3.3.2 アプリケーションのコンパイル・実行
アプリケーションソースをコンパイル・実行する場合、List Managerが提供するJarファイル（f3hxcopr.jar、f3hxcjop.jar）に対してクラスパ
スを設定してコンパイル・実行する必要があります。
●開発時
Javaソースをコンパイルするときには、Jarファイル（f3hxcopr.jar）をクラスパスに設定します。
以下にjavacコマンドでコンパイルするときの例を示します。
javac -classpath .:/opt/FJSVlstm/classes/f3hxcopr.jar Xyz.java
(*1)
*1：
コンパイルするソース名を指定します。
●実行時
コンパイルしたプログラムを実行するときには、Jarファイル（f3hxcopr.jar、f3hxcjop.jar）をクラスパスに設定します。
なお、実行時に必要な環境変数については、以下を参照してください。
⇒“3.2 帳票管理アプリケーション実行時に設定する環境変数”
以下にjavaコマンドで実行するときの例を示します。
java -classpath .:/opt/FJSVlstm/classes/f3hxcopr.jar:/opt/FJSVlstm/classes/f3hxcjop.jar Xyz
(*1)
*1：
コンパイルしたJavaクラス名を指定します。
3.4 帳票管理Javaインタフェースで指定できる文字
以下に、帳票管理Javaインタフェースで指定できる文字について示します。
●指定できる範囲
帳票管理Javaインタフェースで使用できる文字/記号の範囲について示します。
指定できる文字/
記号
半角文字
範囲
ASCIIコードで0x20～0x7Eの範囲の文字
半角英数字
A～Z、a～z、0～9の範囲の文字
半角数字
0～9の範囲の文字
半角記号
ASCIIコードで0x20～0x3F、0x5B～0x5F、0x7B～0x7Eの範囲の文字
全角文字
ASCIIコード0x00～0x7Fの範囲を除いた文字
●指定できる文字/記号
帳票管理Javaインタフェースのパラメータごとに、指定できる文字/記号について示します。
- 20 -
情報
指定できる文字/記号
文字列長
（バイト）
大文字小
文字の区
別
帳票名
半角文字。ただし、半角記号「\」、「/」、「,」、「:」、「;」、「<」、「>」、 64
「|」、「’」、「%」、「”」、「@」を除く
○
帳票ID(*1)
半角数字と半角記号「-」
33
－
論理あて先(*1)
半角英数字と半角記号「!」、「$」、「&」、「(」、「)」、「=」、「-」、「~」、 80
「^」、「`」、「[」、「]」、「{」、「}」、「_」、「.」
○
ユーザグループID
半角文字。ただし、半角記号「\」、「/」、「,」、「:」、「;」、「<」、「>」、 16
「|」、「[」、「]」、「=」、「’」、「」（空白）、「+」を除く
○
ユーザID
半角文字。ただし、半角記号「\」、「/」、「,」、「:」、「;」、「<」、「>」、
「|」、「[」、「]」、「=」、「’」、「」（空白）、「+」、「"」を除く
論理デバイス(*1)
論理デバイス区分(*1)
（作成ユーザ）
パスワード
半角文字。ただし、半角記号「’」を除く
16
○
通信対象
コンピュータ名
半角英数字と半角記号「-」、「.」、「*」、「?」、「:」
255
○
半角文字と全角文字。ただし、半角記号「;」、「”」、「’」を除く
256
○
依頼元端末
タイトル
コメント
カスタマイズ項目
(*2)
業務あて先
半角文字と全角文字。ただし、半角記号「;」、「”」、「’」を除く
256
○
メッセージ通知先
（通知メッセージ）
半角英数字と半角記号「-」、「.」
255
○
メッセージ通知先
（返答メッセージ/応答
メッセージ）
半角英数字と半角記号「-」、「.」
255
○
○：
大文字小文字を区別して扱われる
－：
関係なし
*1：
情報を検索するときの検索条件に、ワイルドカード文字として、「*」および「?」を使用できます。
*2：
カスタマイズ項目の文字列長については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”の“9.2.3.1 カスタマイズ項
目とは”を参照してください。
3.5 クラス一覧
以下に、帳票管理Javaインタフェースが提供するパッケージのクラスを一覧で示します。
com.fujitsu.listmanager.operateパッケージ
分類
ユーザ関連
クラス名
UserAuthorizationクラス
説明
List Managerのユーザ認証を行うクラスです。
- 21 -
分類
クラス名
説明
LMUserクラス
List Managerのユーザに関する基本情報を取得するクラス
です。
LMUserInfoクラス
ユーザごとの帳票管理情報を取得/変更するためのクラス
です。
LMUserManagerクラス
List Managerのユーザを管理するクラスです。
LMUserGroupクラス
ユーザグループ情報を取得するクラスです。
LMNameクラス
getUserGroupNamesメソッドおよびgetUserNamesメソッドで
取得した情報を提供するクラスです。
LogicalDestinationManagerクラス
論理あて先の取得/検索を行うクラスです。
LogicalDestinationクラス
論理あて先情報の取得、論理あて先に対する操作、および
論理あて先内の帳票の取得/検索を行うクラスです。
LogicalDestinationFilterConditionクラス
論理あて先を検索するときの検索条件を指定するクラスで
す。
LogicalDeviceManagerクラス
論理デバイスの取得/検索を行うクラスです。
LogicalDeviceクラス
論理デバイス情報を取得するクラスです。
LogicalDeviceFilterConditionクラス
論理デバイスを検索するときの検索条件を指定するクラス
です。
FormManagerクラス
論理あて先を意識せずに、帳票の取得/検索を行うクラスで
す。
Formクラス
帳票属性の取得、および帳票に対する操作を行うクラスで
す。
FormFilterConditionクラス
帳票を検索するときの検索条件を指定するクラスです。
ソート指定
SortOrderクラス
一覧で取得する結果や検索結果のソート順を指定するクラ
スです。
一覧取得
ListResultクラス
情報を一覧で取得した結果を保持するクラスです。
パラメータ関連
LMParameterKeyクラス
パラメータ基本クラスに保持するパラメータのキーおよび値
として指定するフィールドが定義されているクラスです。
LMParameterクラス
帳票管理Javaインタフェースの各メソッド呼び出しにあたり、
「パラメータ名とパラメータ値」の対応関係をキーと値として
保持することが可能なパラメータ基本クラスです。
LMParametersListクラス
パラメータ基本クラスを登録順のリスト形式で保持するクラ
スです。
OperateExceptionクラス
帳票管理Javaインタフェースで発生する例外クラスです。
OperateFormExceptionクラス
帳票に対する操作で発生する例外クラスです。
OperateAllFormsExceptionクラス
論理あて先内の帳票を、一括操作したときに発生する例外
クラスです。
論理あて先
関連
論理デバイス関
連
帳票関連
例外
3.6 クラスの詳細（ユーザ関連）
ユーザに関するクラスの詳細について説明します。
ポイント
情報を一覧取得するメソッドの実行時、メソッドが実行されるたびに最新の情報を取得します。
例えば、同じパラメータでメソッドを連続で実行した場合、メソッドの実行の間に情報が更新されていれば、取得される情報が違うもの
になる可能性があります。
- 22 -
3.6.1 UserAuthorizationクラス
List Managerのユーザ認証を行うクラスです。
ユーザ認証は、操作画面、または帳票ブラウザのログイン画面からログインする操作に該当します。
帳票管理アプリケーション機能を使用するには、まず、このユーザ認証が必要です。認証に成功すると、そのユーザが所属するLMUser
クラスまたはLMUserManagerクラスが取得され、取得したクラスから、論理あて先や帳票を管理するクラスを生成できます。
java.lang.Object
└com.fujitsu.listmanager.operate.UserAuthorization
public class UserAuthorization
extends java.lang.Object
3.6.1.1 メソッドの概要
UserAuthorizationクラスのメソッドを以下に示します。
メソッドの概要
static LMUser
authorize(java.lang.String userID,java.lang.String password)
ユーザ認証を行います。
static LMUser
authorize (java.lang.String userID, java.lang.String password,
LMParametersList loginInfo)
ユーザ認証を行います。
ログイン時の情報をLMParametersListクラスを使用して指定します。
ポイント
各ユーザ情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.6.1.2 メソッドの詳細
public static LMUser
authorize(java.lang.String userID,java.lang.String password)
throws OperateException
用途
ユーザ認証を行います。
パラメータ
userID：
認証するユーザのユーザIDを指定します。
password：
認証するユーザのパスワードを指定します。
戻り値
ユーザが所属するクラス
LMUserクラスまたはLMUserManagerクラスが取得されます。
- 23 -
なお、指定したユーザIDやパスワードに誤りがあり、認証に失敗した場合は「null」が取得されます。
例外
OperateException：
認証処理でエラーが発生した場合
public static LMUser
authorize (java.lang.String userID, java.lang.String password, LMParametersList loginInfo)
throws OperateException, java.lang.IllegalArgumentException
用途
ユーザ認証を行います。
ログイン時の情報をLMParametersListクラスを使用して指定します。
パラメータ
userID：
認証するユーザのユーザID を指定します。
password：
認証するユーザのパスワードを指定します。
loginInfo：
以下のログイン時の情報を、LMParameterKeyクラスの以下のキーで指定します。
指定可能な文字数は1～85文字の範囲です。
なお、範囲外の文字数を指定した場合の動作は、保障されません。
－ PARAM_LOGIN_TERMINAL（端末識別子）
端末識別子の値として、IPアドレス、ホスト名をStringオブジェクトで指定します。
指定した情報は、監査証跡ログ（操作ログ）の「操作端末」として出力されます。
端末識別子を指定しなかった場合、監査証跡ログ（操作ログ）に「操作端末」が出力されません。
－ PARAM_LOGIN_OPERATERINFO（出力ユーザ）
帳票の再出力時に、帳票へ出力する「出力ユーザ」として出力ユーザの情報をStringオブジェクトで指定します。
- 出力ユーザの情報に指定可能な文字範囲は、JIS非漢字、JIS第一水準漢字、JIS第二水準漢字です。外字は使用できま
せん。
- 出力ユーザの情報に空文字が指定された場合、出力ユーザIDは出力されません。
- 出力ユーザの情報を指定しなかった場合、帳票管理サーバの環境設定ファイルの設定にしたがいます。
戻り値
ユーザが所属するクラス
LMUser クラス、またはLMUserManager クラスが取得されます。
なお、指定したユーザID やパスワードに誤りがあり、認証に失敗した場合は「null」が取得されます。
例外
OperateException：
認証処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
－ loginInfoパラメータの各キーに「null」が指定された場合
- 24 -
－ loginInfoパラメータに指定できないキーを指定した場合
－ loginInfoパラメータに有効なキーが存在しない場合
－ PARAM_LOGIN_TERMINALキーにStringオブジェクト以外の値が指定されている場合
－ PARAM_LOGIN_OPERATERINFOキーにStringオブジェクト以外の値が指定されている場合
注意
・ loginInfoパラメータに「null」を指定した場合は、監査証跡ログ（操作ログ）に「操作端末」が出力されません。また、出力ユーザは、
帳票管理サーバの環境設定ファイルの設定にしたがいます。
備考
・ loginInfoパラメータの出力ユーザの情報は、以下の場合に出力されます。
－ FormクラスのprintoutメソッドにおいてisOutputパラメータに「true」を指定した場合
－ FormクラスのcopyメソッドおよびmoveメソッドにおいてisOutputパラメータに「true」を指定した場合
－ FormクラスのcreateOutputDataメソッドを指定した場合
－ Formクラスのpreview メソッドを指定した場合
－ LogicalDestinationクラスのcopyAllFormsメソッドにおいてisOutputパラメータに「true」を指定した場合
3.6.2 LMUserクラス
List Managerのユーザに関する基本情報を取得するクラスです。
UserAuthorizationクラスでユーザ認証を行うことによって取得されます。
java.lang.Object
└com.fujitsu.listmanager.operate.LMUser
public class LMUser
extends java.lang.Object
注意
一般ユーザで認証した場合には、当該ユーザのユーザ情報だけを取得します。
3.6.2.1 メソッドの概要
LMUserクラスのメソッドを以下に示します。
メソッドの概要
java.lang.String
getUserID()
ユーザのユーザIDを取得します。
java.lang.String
getFullName()
ユーザのフルネームを取得します。
java.lang.String
getComment()
ユーザのコメントを取得します。
java.lang.String[]
getUserGroupID()
ユーザが所属するユーザグループIDを取得します。
- 25 -
メソッドの概要
LMUserInfo
getUserInfo()
LMUserInfoクラスを取得します。
LMName[]
getUserNames(java.lang.String[] userIDs, SortOrder[] sortOrder)
ユーザIDに対応するユーザ名（フルネーム）の一覧を取得します。
LMName[]
getUserGroupNames(java.lang.String[] groupIDs, SortOrder[] sortOrder)
ユーザグループIDに対応するユーザグループ名の一覧を取得します。
void
logout(LMParametersList logoutInfo)
ログアウトを行います。
ポイント
各ユーザ情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.6.2.2 メソッドの詳細
public java.lang.String
getUserID()
用途
ユーザのユーザIDを取得します。
戻り値
ユーザID
public java.lang.String
getFullName()
用途
ユーザのフルネームを取得します。
戻り値
フルネーム
public java.lang String
getComment()
用途
ユーザのコメントを取得します。
戻り値
コメント
なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。
- 26 -
public java.lang.String[]
getUserGroupID()
用途
ユーザが所属するユーザグループIDを取得します。
戻り値
ユーザグループIDの配列
public LMUserInfo
getUserInfo()
throws OperateException,java.lang.IllegalStateException
用途
LMUserInfoクラスを取得します。
戻り値
LMUserInfoクラス
例外
OperateException：
LMUserInfoクラスの取得処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public LMName[]
getUserNames(java.lang.String[] userIDs, SortOrder[] sortOrder)
throws OperateException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
ユーザIDに対応するユーザ名（フルネーム）の一覧を取得します。
パラメータ
userIDs：
取得したいユーザのユーザIDを指定します。
ユーザIDは複数指定できます。複数指定した場合は、論理和条件（OR条件）になります。
ユーザIDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできます。
sortOrder：
取得したユーザ名（フルネーム）をソートする場合、並べ替えのキーにするソート項目を指定します。
- 27 -
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定
したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
ユーザIDについて、「ユーザID」をid、「ユーザ名（フルネーム）」をnameとしたLMNameオブジェクトの配列を取得します。
例外
OperateException：
ユーザ名（フルネーム）の取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を3個以上指定した場合
・ userIDsパラメータに「null」を指定した場合
・ userIDsパラメータで指定した配列内の値に「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
・ userIDsパラメータ中に同一のユーザIDが存在した場合は、検索性能が遅くなります。ユーザアプリケーションプログラム側で重複
値を排除することを推奨します。
・ LMNameオブジェクトの配列は、SortOrderメソッドで指定した並び順で取得されます。
SortOrderメソッドを使用しない場合は、この限りではありません。
・ユーザIDが1つも存在しない場合、LMNameオブジェクトの配列数は0となります。
public LMName[]
getUserGroupNames(java.lang.String[] groupIDs, SortOrder[] sortOrder)
throws OperateException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
ユーザグループIDに対応するユーザグループ名の一覧を取得します。
パラメータ
groupIDs：
取得したいユーザグループのユーザグループIDを指定します。
ユーザグループIDは複数指定できます。複数指定した場合は、論理和条件（OR条件）になります。
- 28 -
ユーザグループIDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
sortOrder：
取得したユーザグループ名をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定
したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
ユーザグループIDについて、「ユーザグループID」をid、「ユーザグループ名」をnameとしたLMNameオブジェクトの配列を取得しま
す。
例外
OperateException：
ユーザグループ名の取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を3個以上指定した場合
・ groupIDsパラメータに「null」を指定した場合
・ groupIDsパラメータで指定した配列内の値に「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
・ groupIDsパラメータ中に同一のユーザグループIDが存在した場合は、検索性能が遅くなります。ユーザアプリケーションプログラ
ム側で重複値を排除することを推奨します。
・ LMNameオブジェクトの配列は、SortOrderメソッドで指定した並び順で取得されます。
SortOrderメソッドを使用しない場合は、この限りではありません。
・ユーザグループIDが1つも存在しない場合、LMNameオブジェクトの配列数は0となります。
public void
logout(LMParametersList logoutInfo)
throws OperateException, java.lang.IllegalArgumentException
用途
ログアウトを行います。
このメソッドを使用するには、セキュリティモードの設定を、「ログインセキュリティの強化を行う」設定にする必要があります。
- 29 -
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
パラメータ
logoutInfo：
ログアウト時の情報を、LMParameterKeyクラスのPARAM_LOGOUT_FACTORキーを使用してログアウト要因を指定します。
ログアウト要因は、以下の値で指定してください。
－ PARAM_LOGOUT_VALUE_LOGOUT（ログアウト操作）
－ PARAM_LOGOUT_VALUE_SESSIONTIMEOUT（セッションタイムアウト）
例外
OperateException：
ログアウト処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・ logoutInfoパラメータのキーに「null」が指定された場合
・ logoutInfoパラメータに指定できないキーを指定した場合
・ logoutInfoパラメータに有効なキーが存在しない場合
・ PARAM_LOGOUT_FACTORキーで指定するログアウト要因として、許可されていない値が指定された場合
注意
・実行ユーザがログイン状態ではない場合、帳票管理Javaインタフェースを使用することはできません。再度、ユーザ認証から行っ
てください。
実行ユーザがログイン状態ではない場合に以下のコンストラクタ、およびメソッドが実行された場合は、java.lang.IllegalStateException
が発生します。
クラス
LMUserクラス
コンストラクタ、およびメソッド
getUserInfoメソッド
getUserNamesメソッド
getUserGroupNamesメソッド
LMUserInfoクラス
updateAutoRefreshメソッド
updateFormFilterConditionメソッド
updateLDFilterConditionメソッド
updateMaxFormsメソッド
updateDisplayErrorMessageメソッド
LMUserManagerクラス
getUsersメソッド
getUserGroupsメソッド
LogicalDestinationManagerクラス
LogicalDestinationManagerコンストラクタ
getLogicalDestinationsメソッド
getLogicalDestinationNamesメソッド
getLogicalDestinationsCountメソッド
LogicalDestinationクラス
startメソッド
stopメソッド
changeDeviceメソッド
- 30 -
クラス
コンストラクタ、およびメソッド
getFormメソッド
getFormsメソッド
getFormsCountメソッド
resumeAllFormsメソッド
cancelAllFormsメソッド
forceCancelAllFormsメソッド
deleteAllFormsメソッド
copyAllFormsメソッド
LogicalDeviceManagerクラス
LogicalDeviceManagerコンストラクタ
getLogicalDevicesメソッド
FormManagerクラス
FormManagerコンストラクタ
getFormメソッド
getFormsメソッド
getFormsCountメソッド
updateメソッド
Formクラス
printoutメソッド
previewメソッド
cancelメソッド
forceCancelメソッド
responseErrorメソッド
deleteメソッド
copyメソッド
moveメソッド
createOutputDataメソッド
・実行ユーザがログアウト状態でも上記以外のメソッド（FormFilterConditionクラスのメソッドなど）では例外は発生しません。
・セキュリティモード有効時は、ログイン・ログアウント状態にかかわらず、LMUserパラメータなしでLogicalDeviceManager クラスの生
成が実行された場合には、例外が発生します。
3.6.3 LMUserInfoクラス
ユーザごとの帳票管理情報を取得/変更するためのクラスです。
LMUserクラスのメソッドから取得されます。
java.lang.Object
└com.fujitsu.listmanager.operate.LMUserInfo
public class LMUserInfo
extends java.lang.Object
注意
・一般ユーザが自分以外のユーザのユーザごとの帳票管理情報を取得する場合、List Managerの管理者権限が必要です。
- 31 -
・このクラスのメソッドで以下の値を変更した場合、List Manager管理データベースで管理している、操作画面の帳票一覧画面や絞
り込み画面の設定値も変更されます。
－取得した帳票一覧の自動更新
－取得した帳票一覧の自動更新間隔
－帳票の絞り込み条件
－論理あて先の絞り込み条件
－帳票一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表示
3.6.3.1 メソッドの概要
LMUserInfoクラスのメソッドを以下に示します。
メソッドの概要
java.lang.String
getUserID()
ユーザのユーザIDを取得します。
java.lang.String
getFullName()
ユーザのフルネームを取得します。
java.lang.String
getSurname()
ユーザの姓を取得します。
java.lang.String
getComment()
ユーザのコメントを取得します。
boolean
isAutoRefresh()
取得した帳票一覧を自動更新するかどうかの設定を取得します。
int
getAutoRefreshTime()
取得した帳票一覧の自動更新間隔の値を取得します。
java.lang.String
getLastViewLD()
ユーザが最後に帳票を取得/検索した論理あて先名を取得します。
boolean
isSaveFormFilterCondition()
帳票の絞り込み条件を保存するかどうかの設定を取得します。
FormFilterCondition
getFormFilterCondition()
帳票の絞り込み条件を取得します。
boolean
isSaveLDFilterCondition()
論理あて先の絞り込み条件を保存するかどうかの設定を取得します。
LogicalDestination
FilterCondition
getLDFilterCondition()
int
getMaxForms()
論理あて先の絞り込み条件を取得します。
帳票を一覧取得する場合の最大取得帳票数の設定値を取得します。
boolean
isDisplayErrorMessage()
帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表
示の設定値を取得します。
java.lang.String[]
getErrorWatchRange()
応答メッセージを表示させる論理あて先名を取得します。
- 32 -
メソッドの概要
void
updateAutoRefresh(boolean autoRefresh,int time)
List Manager管理データベースにユーザごとに管理されている以下の値を更新し
ます。
－取得した帳票一覧を自動更新するかどうか
－自動更新間隔（自動更新を行う間隔）
void
updateFormFilterCondition(boolean save,FormFilterCondition condition)
List Manager管理データベースにユーザごとに管理されている以下の値を更新し
ます。
－帳票の絞り込み条件を保存するかどうか
－帳票の絞り込み条件
void
updateLDFilterCondition(boolean save,LogicalDestinationFilterCondition
condition)
List Manager管理データベースにユーザごとに管理されている以下の値を更新し
ます。
－論理あて先の絞り込み条件を保存するかどうか
－論理あて先の絞り込み条件
void
updateMaxForms(int forms)
List Manager管理データベースにユーザごとに管理されている、帳票を一覧取得
する場合の最大取得帳票数の値を指定します。
void
updateDisplayErrorMessage(boolean display, java.lang.String[]
logicalDestinationNames)
List Manager管理データベースに管理されている以下の値を更新します。
－帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非
表示
－応答メッセージを表示させる論理あて先名
ポイント
各ユーザ情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.6.3.2 メソッドの詳細
public java.lang.String
getUserID()
用途
ユーザのユーザIDを取得します。
戻り値
ユーザID
public java.lang.String
getFullName()
- 33 -
用途
ユーザのフルネームを取得します。
戻り値
フルネーム
public java.lang.String
getSurname()
用途
ユーザの姓を取得します。
戻り値
姓
public java lang.String
getComment()
用途
ユーザのコメントを取得します。
戻り値
コメント
なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public boolean
isAutoRefresh()
用途
取得した帳票一覧を自動更新するかどうかの設定を取得します。
戻り値
true：
自動更新する設定の場合
false：
自動更新しない設定の場合
public int
getAutoRefreshTime()
用途
取得した帳票一覧の自動更新間隔の値を取得します。
- 34 -
戻り値
自動更新間隔（秒）
public java.lang.String
getLastViewLD()
用途
ユーザが最後に帳票を取得/検索した論理あて先名を取得します。
戻り値
論理あて先名
なお、ユーザが一度も帳票を取得していない場合は、「null」が取得されます。
備考
・ユーザが最後に帳票を取得/検索した論理あて先名は、以下の処理を行った場合に、帳票管理Javaインタフェースが自動的に設
定します。
－ LogicalDestinationクラスのgetFormメソッドまたはgetFormsメソッドで、帳票を取得した場合
帳票の取得時に、条件に一致する帳票がなかった場合でも、設定値が更新されます。
－ FormManagerクラスのgetFormsメソッドで、論理あて先名を指定して帳票を取得した場合
ただし、以下の場合、設定値は更新されません。
- 帳票の取得時に条件に一致する帳票がなかった場合
- 論理あて先名にnullを指定した場合
- 論理あて先名の一部にワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定した場合
－操作画面の帳票一覧画面を表示した場合
ただし、論理あて先内に帳票がなかった場合、設定値は更新されません。
public boolean
isSaveFormFilterCondition()
用途
帳票の絞り込み条件を保存するかどうかの設定値を取得します。
戻り値
true：
帳票の絞り込み条件を保存する設定の場合
false：
帳票の絞り込み条件を保存しない設定の場合
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public FormFilterCondition
getFormFilterCondition()
- 35 -
用途
帳票の絞り込み条件を取得します。
戻り値
帳票の絞り込み条件
なお、帳票の絞り込み条件が指定されていない場合は、条件が何も指定されていないFormFilterConditionクラスが取得されます。
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public boolean
isSaveLDFilterCondition()
用途
論理あて先の絞り込み条件を保存するかどうかの設定を取得します。
戻り値
true：
論理あて先の絞り込み条件を保存する設定の場合
false：
論理あて先の絞り込み条件を保存しない設定の場合
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public LogicalDestinationFilterCondition
getLDFilterCondition()
用途
論理あて先の絞り込み条件を取得します。
戻り値
論理あて先の絞り込み条件
なお、論理あて先の絞り込み条件が指定されていない場合は、条件が何も指定されていないLogicalDestinationFilterConditionクラス
が取得されます。
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public int
getMaxForms()
- 36 -
用途
帳票を一覧取得する場合の最大取得帳票数の設定値を取得します。
最大取得帳票数は、帳票を一覧取得する場合の帳票の最大数です。
戻り値
最大取得帳票数
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public boolean
isDisplayErrorMessage()
用途
帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表示の設定値を取得します。
戻り値
true：
応答メッセージを表示する設定の場合
false：
応答メッセージを表示しない設定の場合
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public java.lang.String[]
getErrorWatchRange()
用途
応答メッセージを表示させる論理あて先名を取得します。
応答メッセージを表示させることができるのは、対応付けされている論理デバイスの出力方法が帳票配信の場合の「プリンタ（印刷）」
の論理あて先です。
戻り値
論理あて先名の配列
なお、論理あて先が指定されていない場合は、「null」が取得されます。
備考
・ List Manager管理データベースにユーザごとに管理されている値が取得されます。
public void
updateAutoRefresh(boolean autoRefresh,int time)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
- 37 -
用途
List Manager管理データベースにユーザごとに管理されている以下の値を更新します。
・取得した帳票一覧を自動更新するかどうか
・自動更新間隔（自動更新を行う間隔）
パラメータ
autoRefresh：
取得した帳票一覧を自動更新するかどうかを指定します。
true：
自動更新する場合に指定します。
false：
自動更新しない場合に指定します。
time：
自動更新間隔（秒）を10～999の範囲で指定します。
例外
OperateException：
変更処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
指定した自動更新間隔（秒）が10～999以外の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・このメソッドを指定した場合、操作画面の帳票一覧画面の自動更新および自動更新間隔の値も変更されます。
備考
・このメソッドで設定した値は、List Manager管理データベースにユーザごとに管理されます。ただし、このメソッドは、List Manager管
理データベースに値を保存する機能を提供しているだけであり、ここで指定した値によって、帳票管理Javaインタフェースの各クラ
スのメソッドの値や動作が変更されることはありません。
・ AutoRefreshパラメータとtimeパラメータは関連していません。List Manager管理データベースでは、以下の設定値は別々に管理さ
れています。
－自動更新するかどうか
－自動更新間隔
このため、AutoRefreshパラメータに「false」を指定した場合でも、timeパラメータを使用して、自動更新間隔の値をList Manager管
理データベースに保存できます。
public void
updateFormFilterCondition(boolean save,FormFilterCondition condition)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
- 38 -
用途
List Manager管理データベースにユーザごとに管理されている以下の値を更新します。
・帳票の絞り込み条件を保存するかどうか
・帳票の絞り込み条件
パラメータ
save：
帳票の絞り込み条件を保存するかどうかを指定します。
true：
帳票の絞り込み条件を保存する設定に変更する場合に指定します。
false：
帳票の絞り込み条件を保存しない設定に変更する場合に指定します。
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
例外
OperateException：
変更処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
conditionパラメータに「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・このメソッドのconditionパラメータを指定した場合、操作画面の絞り込み画面（帳票一覧画面）で保存した帳票の絞り込み条件も変
更されます。
備考
・このメソッドで設定した値は、List Manager管理データベースにユーザごとに管理されます。ただし、このメソッドは、List Manager管
理データベースに値を保存する機能を提供しているだけであり、ここで指定した値によって、帳票管理Javaインタフェースの各クラ
スのメソッドの値や動作が変更されることはありません。
・ saveパラメータとconditionパラメータは関連していません。List Manager管理データベースでは、以下の設定値は別々に管理され
ています。
－帳票の絞り込み条件の保存
－帳票の絞り込み条件
このため、saveパラメータに「false」を指定した場合でも、conditionパラメータを使用して、帳票の絞り込み条件をList Manager管理
データベースに保存できます。
public void
updateLDFilterCondition(boolean save,LogicalDestinationFilterCondition condition)
- 39 -
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
List Manager管理データベースにユーザごとに管理されている以下の値を更新します。
・論理あて先の絞り込み条件を保存するかどうか
・論理あて先の絞り込み条件
パラメータ
save：
論理あて先の絞り込み条件を保存するかどうかを指定します。
true：
論理あて先の絞り込み条件を、保存する設定に変更する場合に指定します。
false：
論理あて先の絞り込み条件を、保存しない設定に変更する場合に指定します。
condition：
論理あて先の絞り込み条件を指定します。
論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”
例外
OperateException：
変更処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
conditionパラメータに「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・このメソッドのconditionパラメータを指定した場合、絞り込み画面（論理あて先一覧画面）で保存した論理あて先の絞り込み条件も
変更されます。
備考
・このメソッドで設定した値は、List Manager管理データベースにユーザごとに管理されます。ただし、このメソッドは、List Manager管
理データベースに値を保存する機能を提供しているだけであり、ここで指定した値によって、帳票管理Javaインタフェースの各クラ
スのメソッドの値や動作が変更されることはありません。
・ saveパラメータとconditionパラメータは関連していません。List Manager管理データベースでは、以下の設定値は別々に管理され
ています。
－論理あて先の絞り込み条件の保存
－論理あて先の絞り込み条件
このため、saveパラメータに「false」を指定した場合でも、conditionパラメータを使用して、論理あて先の絞り込み条件をList Manager
管理データベースに保存できます。
- 40 -
public void
updateMaxForms(int forms)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
List Manager管理データベースにユーザごとに管理されている、帳票を一覧取得する場合の最大取得帳票数の値を指定します。
最大取得帳票数は、帳票を一覧取得する場合の帳票の最大数です。
パラメータ
forms：
帳票を一覧取得する場合の最大数を、0～9999の範囲で指定します。
無制限にする場合は「0」を指定します。
例外
OperateException：
変更処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
指定した帳票の最大数が0～9999以外の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
・このメソッドで設定した値は、List Manager管理データベースにユーザごとに管理されます。ただし、このメソッドは、List Manager管
理データベースに値を保存する機能を提供しているだけであり、ここで指定した値によって、帳票管理Javaインタフェースの各クラ
スのメソッドの値や動作が変更されることはありません。
public void
updateDisplayErrorMessage(boolean display, java.lang.String[] logicalDestinationNames)
throws OperateException, java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
List Manager管理データベースに管理されている以下の値を更新します。
・帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表示
・応答メッセージを表示させる論理あて先名
応答メッセージを表示させることができるのは、対応付けされている論理デバイスの出力方法が「帳票配信型の場合のプリンタ（印
刷）」の論理あて先です。
パラメータ
display：
帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表示を指定します。
true：
応答メッセージを表示する場合に指定します。
- 41 -
false：
応答メッセージを表示しない場合に指定します。
logicalDestination Names：
応答メッセージを表示させる論理あて先名を配列で指定します。
例外
OperateException：
変更処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
logicalDestinationNamesパラメータが「null」の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・このメソッドを指定した場合、操作画面の帳票一覧画面の［応答］ボタンにも、以下のように影響を与えます。
－ displayパラメータに「true」を指定した場合
操作画面の帳票一覧画面の［応答］ボタンは表示されます。
－ displayパラメータに「false」を指定した場合
操作画面の帳票一覧画面の［応答］ボタンは非表示になります。
・ displayパラメータとlogicalDestinationNamesパラメータは関連していません。List Manager管理データベースでは、以下の設定値
は別々に管理されています。
－帳票の一覧取得時に、応答待ちが発生した帳票の応答メッセージの表示/非表示
－応答メッセージを表示させる論理あて先名
このため、displayパラメータに「false」を指定した場合でも、logicalDestinationNamesパラメータを使用して、応答メッセージを表示
させる論理あて先名をList Manager管理データベースに保存できます。
備考
・このメソッドで設定した値は、List Manager管理データベースにユーザごとに管理されます。ただし、このメソッドは、List Manager管
理データベースに値を保存する機能を提供しているだけであり、ここで指定した値によって、帳票管理Javaインタフェースの各クラ
スのメソッドの値や動作が変更されることはありません。
3.6.4 LMUserManagerクラス
List Managerのユーザを管理するクラスです。
UserAuthorizationクラスで、List Managerの管理者権限でユーザ認証を行うことによって取得されます。
一般ユーザでは許可されていない操作（ユーザ/ユーザグループの取得/検索）を行うことができます。
java.lang.Object
└com.fujitsu.listmanager.operate.LMUser
└com.fujitsu.listmanager.operate.LMUserManager
public class LMUserManager
extends LMUser
- 42 -
注意
このクラスのメソッドを使用して、ユーザ/ユーザグループを取得するには、List Managerの管理者権限が必要です。
ポイント
検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカード文
字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われない場合
があります。
3.6.4.1 メソッドの概要
LMUserManagerクラスのメソッドを以下に示します。
メソッドの概要
LMUser[]
getUsers(SortOrder[] sortOrder)
List Managerのすべてのユーザを取得します。
LMUser[]
getUsers(java.lang.String userID,java.lang.String groupID,SortOrder[]
sortOrder)
検索条件にList ManagerのユーザIDおよびユーザグループIDを指定して、ユー
ザを取得します。
LMUserGroup[]
getUserGroups(SortOrder[] sortOrder)
List Managerのすべてのユーザグループを取得します。
LMUserGroup[]
getUserGroups(java.lang.String groupID,SortOrder[] sortOrder)
検索条件にList ManagerのユーザグループIDを指定して、ユーザグループを取
得します。
ポイント
各ユーザ情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.6.4.2 メソッドの詳細
public LMUser[]
getUsers(SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
List Managerのすべてのユーザを取得します。
このメソッドで取得されるユーザは、すべてLMUserクラスです。
List Managerの管理者権限を持つユーザのLMUserクラスも取得されます。
パラメータ
sortOrder：
取得したユーザをソートする場合、並べ替えのキーにするソート項目を指定します。
- 43 -
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
すべてのユーザの配列
なお、ユーザが存在しない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public LMUser[]
getUsers(java.lang.String userID,java.lang.String groupID,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
検索条件にList ManagerのユーザIDおよびユーザグループIDを指定して、ユーザを取得します。
このメソッドで取得されるユーザは、すべてLMUserクラスです。
List Managerの管理者権限を持つユーザもLMUserクラスで取得されます。
パラメータ
userID：
検索するユーザのユーザIDを指定します。
ユーザIDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
groupID：
検索するユーザグループIDを指定します。
ユーザグループIDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 44 -
sortOrder：
取得したユーザをソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致したユーザの配列
なお、条件に一致するユーザがいない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public LMUserGroup[]
getUserGroups(SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
List Managerのすべてのユーザグループを取得します。
パラメータ
sortOrder：
取得したユーザグループをソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
すべてのユーザグループの配列
- 45 -
なお、ユーザグループが存在しない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public LMUserGroup[]
getUserGroups(java.lang.String groupID,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
検索条件にList ManagerのユーザグループIDを指定して、ユーザグループを取得します。
パラメータ
groupID：
検索するユーザグループのユーザグループIDを指定します。
ユーザグループIDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得したユーザグループをソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致したユーザグループの配列
なお、条件に一致するユーザグループがない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
- 46 -
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
3.6.5 LMUserGroupクラス
ユーザグループ情報を取得するクラスです。
UserAuthorizationクラスで、List Managerの管理者権限でユーザ認証した場合に取得できます。
LMUserManagerクラスから取得されます。
java.lang.Object
└com.fujitsu.listmanager.operate.LMUserGroup
public class LMUserGroup
extends java.lang.Object
注意
このクラスのメソッドを使用してユーザグループ情報を取得するには、List Managerの管理者権限が必要です。
3.6.5.1 メソッドの概要
LMUserGroupクラスのメソッドを以下に示します。
メソッドの概要
java.lang.String
getGroupID()
ユーザグループのユーザグループIDを取得します。
java.lang.String
getGroupName()
ユーザグループのユーザグループ名を取得します。
java.lang.String
getComment()
ユーザグループのコメントを取得します。
ポイント
各ユーザグループ情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.6.5.2 メソッドの詳細
public java.lang.String
getGroupID()
用途
ユーザグループのユーザグループIDを取得します。
- 47 -
戻り値
ユーザグループID
public java.lang.String
getGroupName()
用途
ユーザグループのユーザグループ名を取得します。
戻り値
ユーザグループ名
public java.lang.String
getComment()
用途
ユーザグループのコメントを取得します。
戻り値
コメント
なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。
3.6.6 LMNameクラス
getUserGroupNamesメソッドおよびgetUserNamesメソッドで取得した情報を提供するクラスです。
java.lang.Object
└com.fujitsu.listmanager.operate.LMName
public class LMName
extends java.lang.Object
3.6.6.1 メソッドの概要
LMNameクラスのメソッドを以下に示します。
メソッドの概要
java.lang.String
getID()
ユーザIDまたはユーザグループIDを取得します。
java.lang.String
getName()
ユーザ名（フルネーム）またはユーザグループ名を取得します。
3.6.6.2 メソッドの詳細
public java.lang.String
getID()
- 48 -
用途
ユーザIDまたはユーザグループIDを取得します。
戻り値
ユーザIDまたはユーザグループID
public java.lang.String
getName()
用途
ユーザ名（フルネーム）またはユーザグループ名を取得します。
戻り値
ユーザ名（フルネーム）またはユーザグループ名
3.7 クラスの詳細（論理あて先関連）
論理あて先に関するクラスの詳細について説明します。
ポイント
情報を一覧取得するメソッドの実行時、メソッドが実行されるたびに最新の情報を取得します。
例えば、同じパラメータでメソッドを連続で実行した場合、メソッドの実行の間に情報が更新されていれば、取得される情報が違うもの
になる可能性があります。
3.7.1 LogicalDestinationManagerクラス
論理あて先の取得/検索を行うクラスです。
検索時の検索条件は、LogicalDestinationFilterConditionクラスを使用して指定します。
java.lang.Object
└com.fujitsu.listmanager.operate.LogicalDestinationManager
public class LogicalDestinationManager
extends java.lang.Object
注意
このクラスのメソッドを使用して、論理あて先を取得するには、論理あて先に対する表示権限が必要です。
3.7.1.1 コンストラクタの概要
LogicalDestinationManagerクラスのコンストラクタを以下に示します。
コンストラクタの概要
LogicalDestinationManager(LMUser user)
LogicalDestinationManagerクラスのLogicalDestinationManagerオブジェクトを生成します。
- 49 -
3.7.1.2 メソッドの概要
LogicalDestinationManagerクラスのメソッドを以下に示します。
メソッドの概要
LogicalDestination[]
getLogicalDestinations(SortOrder[] sortOrder)
論理あて先の一覧を取得します。
LogicalDestination[]
getLogicalDestinations(LogicalDestinationFilterCondition
condition,SortOrder[] sortOrder)
論理あて先の絞り込み条件を指定して、論理あて先の一覧を取得します。
java.lang.String[]
getLogicalDestinationNames()
論理あて先名の一覧を取得します。
ListResult
getLogicalDestinations(LogicalDestinationFilterCondition
condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
論理あて先の絞り込み条件、取得開始位置、および最大取得件数を指定して論
理あて先を取得します。
getLogicalDestinationsCount(LogicalDestinationFilterCondition condition)
int
論理あて先の絞り込み条件を指定して、指定した条件に一致する論理あて先の
総件数を取得します。
ポイント
論理あて先の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.7.1.3 コンストラクタの詳細
public
LogicalDestinationManager(LMUser user)
throws java.lang.IllegalStateException
用途
LogicalDestinationManagerクラスのLogicalDestinationManagerオブジェクトを生成します。
認証したユーザが持つ論理あて先に対する権限が、このクラスに適用されます。
パラメータ
user：
UserAuthorizationクラスまたはLMUserManagerクラスで取得したユーザを指定します。
例外
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
3.7.1.4 メソッドの詳細
public LogicalDestination[]
- 50 -
getLogicalDestinations(SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理あて先の一覧を取得します。
ユーザが持つ表示権限の範囲で、論理あて先を取得できます。
パラメータ
sortOrder：
取得した論理あて先をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
論理あて先の配列
なお、該当する論理あて先がない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public LogicalDestination[]
getLogicalDestinations(LogicalDestinationFilterCondition condition,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理あて先の絞り込み条件を指定して、論理あて先の一覧を取得します。
ユーザが持つ表示権限の範囲で、論理あて先を取得できます。
- 51 -
パラメータ
condition：
論理あて先を絞り込んで検索するときの条件を指定します。
論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した取得した論理あて先をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致した論理あて先の配列
なお、条件に一致する論理あて先がない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public java.lang.String[]
getLogicalDestinationNames()
throws OperateException,java.lang.IllegalStateException
用途
論理あて先名の一覧を取得します。
ユーザが持つ表示権限の範囲で、論理あて先名を取得できます。
戻り値
表示権限のある論理あて先名の配列
なお、表示権限のある論理あて先がない場合は、長さ0の配列が取得されます。
- 52 -
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public ListResult
getLogicalDestinations(LogicalDestinationFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
throws OperateException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
論理あて先の絞り込み条件、取得開始位置、および最大取得件数を指定して論理あて先を取得します。
最大取得件数は取得する論理あて先の最大数です。
論理あて先を取得した結果は、ListResult クラスのgetList メソッドの戻り値をLogicalDestination[]にキャストして取得します。
パラメータ
condition：
論理あて先を絞り込んで検索するときの条件を指定します。
論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した論理あて先をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目名は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優
先度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定
したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
startPosition：
部分取得する際の取得開始位置を指定します。
「0」以下を指定した場合は先頭から取得（「1」を指定した場合に同じ）します。
絞り込み条件（conditionパラメータ）に一致する論理あて先の件数より大きい値を指定した場合は、このメソッドで取得される件数が
0件になります。
resultLimit：
最大取得件数を指定します。
「0」以下を指定した場合は無制限に取得します。
絞り込み条件（conditionパラメータ）に一致する論理あて先の件数より大きい値を指定した場合は、絞り込み条件に一致する論理
あて先の件数分だけ取得し、例外は発生しません。
- 53 -
戻り値
取得した論理あて先の一覧
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先の総件数を取得するには、論理あて先に対する表示権限が必要です。
public int
getLogicalDestinationsCount(LogicalDestinationFilterCondition condition)
throws OperateException, java.lang.IllegalStateException
用途
論理あて先の絞り込み条件を指定して、指定した条件に一致する論理あて先の総件数を取得します。
パラメータ
condition：
論理あて先を絞り込んで検索するときの条件を指定します。
論理あて先の絞り込み条件については、以下を参照してください。
⇒“3.7.3 LogicalDestinationFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
戻り値
指定した条件に一致する論理あて先の総件数
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
- 54 -
注意
・実行ユーザが表示権限を持たない論理あて先の件数はカウントされません。
3.7.2 LogicalDestinationクラス
論理あて先情報の取得、論理あて先に対する操作、および論理あて先内の帳票の取得/検索を行うクラスです。
このクラスは、LogicalDestinationManagerクラスのメソッドから取得されます。
java.lang.Object
└com.fujitsu.listmanager.operate.LogicalDestination
public class LogicalDestination
extends java.lang.Object
注意
このクラスのメソッドを使用するには、論理あて先に対する権限が必要になる場合があります。必要な権限については、各メソッドの注
意を参照してください。
3.7.2.1 フィールドの概要
LogicalDestinationクラスのgetTypeメソッドで取得されるフィールドを以下に示します。
LogicalDestinationクラスのgetTypeメソッドで取得されるフィールド
定数
説明
DOCUMENT_PUSH
論理あて先タイプは、帳票配信用です。
LOCAL_PRINT
論理あて先タイプは、Web手元印刷用です。
LogicalDestinationクラスのgetErrorStatusメソッドで取得されるフィールドを以下に示します。
LogicalDestination クラスのgetErrorStatus メソッドで取得されるフィールド
定数
説明
STATUS_ERROR
出力エラー状態は、エラーです。
STATUS_NORMAL
出力エラー状態は、通常（エラーなし）です。
STATUS_WAIT_REPLY
出力エラー状態は、応答待ちです。
LogicalDestinationクラスのgetOutputModeメソッドで取得されるフィールドを以下に示します。
LogicalDestinationクラスのgetOutputModeメソッドで取得されるフィールド
定数
説明
OUTPUT_MODE_OUTPUT
帳票作成後の出力指定は、「出力する」です。
OUTPUT_MODE_NONE
帳票作成後の出力指定は、「出力しない（帳票の登録のみ行う）」
です。
OUTPUT_MODE_USE_FORM_ATT
RIBUTE
帳票作成後の出力指定は、「帳票属性の編集コマンド（lmedtformatr
コマンド）で定義した帳票属性にしたがう」です。
LogicalDestinationクラスのgetKeepModeメソッドで取得されるフィールドを以下に示します。
- 55 -
LogicalDestinationクラスのgetKeepModeメソッドで取得されるフィールド
定数
説明
KEEP_MODE_KEEP
帳票出力後の保存指定は、「保存する」です。
KEEP_MODE_NONE
帳票出力後の保存指定は、「保存しない」です。
KEEP_MODE_USE_FORM_ATTRIB
UTE
帳票出力後の保存指定は、「帳票属性の編集コマンド（lmedtformatr
コマンド）で定義した帳票属性にしたがう」です。
LogicalDestinationクラスのgetKeepDaysメソッドで取得されるフィールドを以下に示します。
LogicalDestinationクラスのgetKeepDaysメソッドで取得されるフィールド
定数
説明
KEEP_DAYS_NO_LIMIT
保存日数の指定は、無期限です。
KEEP_DAYS_USE_FORM_ATTRIB
UTE
保存日数の指定は、「帳票属性の編集コマンド（lmedtformatrコマ
ンド）で定義した帳票属性にしたがう」です。
3.7.2.2 メソッドの概要
LogicalDestinationクラスのメソッドを以下に示します。
メソッドの概要
java.lang.String
getName()
論理あて先名を取得します。
java.lang.String
getComment()
論理あて先のコメントを取得します。
int
getType()
論理あて先の論理あて先タイプを取得します。
int
getPriority()
論理あて先の優先度を取得します。
java.lang.String
getDeviceName()
論理あて先に対応付けされている論理デバイス名を取得します。
java.lang.String
getDeviceComment()
論理あて先に関連付けされている論理デバイスのコメント（出力先）を取得します。
int
getOutputMethod()
論理あて先に対応付けされている論理デバイスの出力方法を取得します。
boolean
isActive()
論理あて先の状態を取得します。
int
getOutputMode()
帳票作成後の出力指定を取得します。
int
getKeepMode()
帳票出力後の保存指定を取得します。
int
getKeepDays()
論理あて先内の帳票の保存日数の指定を取得します。
- 56 -
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を取得します。
int
getErrorStatus()
論理あて先の出力エラー状態を取得します。
void
start()
論理あて先を起動します。
void
stop()
論理あて先を停止します。
void
changeDevice(LogicalDevice device)
論理あて先に対応付けされている出力先（論理デバイス）を切り替えます。
Form
getForm(java.lang.String formID)
帳票IDを指定して、論理あて先内の帳票を取得します。
Form[]
getForms(SortOrder[] sortOrder)
論理あて先内の帳票を取得します。
ListResult
getForms(SortOrder[] sortOrder,int resultLimit)
最大取得件数を指定して、論理あて先内の帳票を取得します。
Form[]
getForms(FormFilterCondition condition,SortOrder[] sortOrder)
帳票の絞り込み条件を指定して、論理あて先内の帳票を取得します。
ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int resultLimit)
帳票の絞り込み条件、および最大取得件数を指定して、論理あて先内の帳票を
取得します。
ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int
startPosition,int resultLimit)
帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して、論理あ
て先内の帳票を取得します。
int
getFormsCount(FormFilterCondition condition)
帳票の絞り込み条件を指定して、指定した条件に一致する帳票の総件数を取得
します。
void
resumeAllForms(boolean isContinue)
論理あて先内の帳票の出力を一括して保留解除します。
void
resumeAllForms(boolean isContinue,LMParametersList printoutOptions)
印刷部数、メッセージ通知先を指定して、論理あて先内の帳票の出力を一括して
保留解除します。
- 57 -
void
cancelAllForms(boolean isContinue)
論理あて先内の帳票の出力を一括して中止します。
void
forceCancelAllForms(boolean isContinue)
論理あて先内の帳票の出力を、一括して強制的に中止します。
void
deleteAllForms(boolean isContinue)
論理あて先内の帳票を一括して削除します。
void
copyAllForms(java.lang.String toLogicalDestinationName,boolean
isOutput,boolean isContinue)
論理あて先内の帳票を一括して複写します。
複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
void
copyAllForms(java.lang.String toLogicalDestinationName, boolean
isOutput,boolean isContinue,LMParametersList printoutOptions)
論理あて先内の帳票の出力を一括して複写します。
複写と同時に出力を行う場合、印刷部数、メッセージ通知先を指定します。
複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
ポイント
各論理あて先情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.7.2.3 メソッドの詳細
public java.lang.String
getName()
用途
論理あて先名を取得します。
戻り値
論理あて先名
public java.lang.String
getComment()
用途
論理あて先のコメントを取得します。
戻り値
コメント
なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public int
getType()
- 58 -
用途
論理あて先の論理あて先タイプを取得します。
戻り値
論理あて先タイプを示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetTypeメソッドで取得されるフィールド”
public int
getPriority()
用途
論理あて先の優先度を取得します。
論理あて先タイプが「DOCUMENT_PUSH」の場合に、有効な値を取得できます。
戻り値
優先度を示す数値1（優先度：低）～10（優先度：高）
public java.lang.String
getDeviceName()
用途
論理あて先に対応付けされている論理デバイス名を取得します。
戻り値
論理デバイス名
public java.lang.String
getDeviceComment()
用途
論理あて先に対応付けされている論理デバイスのコメント（出力先）を取得します。
戻り値
コメント（出力先）
なお、コメント（出力先）が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public int
getOutputMethod()
用途
論理あて先に対応付けされている論理デバイスの出力方法を取得します。
- 59 -
戻り値
出力方法を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”
public boolean
isActive()
用途
論理あて先の状態を取得します。
論理あて先タイプが「DOCUMENT_PUSH」の場合にのみ、有効な値を取得できます。
戻り値
true：
論理あて先が「起動中」の場合
false：
論理あて先が「停止中」の場合
public int
getOutputMode()
用途
帳票作成後の出力指定を取得します。
帳票作成後の出力指定は、帳票作成後に続けて出力を行うかどうかの指定です。
戻り値
帳票作成後の出力指定を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetOutputModeメソッドで取得されるフィールド”
public int
getKeepMode()
用途
帳票出力後の保存指定を取得します。
帳票出力後の保存指定は、帳票出力後、List Managerに帳票を保存するかどうかの指定です。
戻り値
帳票出力後の保存指定を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetKeepModeメソッドで取得されるフィールド”
public int
- 60 -
getKeepDays()
用途
論理あて先内の帳票の保存日数の指定を取得します。
戻り値
以下のいずれかが取得されます。
・ List Managerで帳票を保存する日数（1～9999）
・帳票の保存日数の指定を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetKeepDaysメソッドで取得されるフィールド”
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
- 61 -
getCustomizeItem4()
用途
論理あて先のカスタマイズ項目4を取得します。
戻り値
カスタマイズ項目4
なお、カスタマイズ項目4が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public java.lang.String
getCustomizeItem5()
用途
論理あて先のカスタマイズ項目5を取得します。
戻り値
カスタマイズ項目5
なお、カスタマイズ項目5が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public int
getErrorStatus()
用途
論理あて先の出力エラー状態を取得します。
戻り値
出力エラー状態を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestination クラスのgetErrorStatus メソッドで取得されるフィールド”
public void
start()
throws OperateException,java.lang.IllegalStateException
用途
論理あて先を起動します。
戻り値
OperateException：
起動処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
- 62 -
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先を起動するには、論理あて先に対する表示権限および管理権限が必要です。
public void
stop()
throws OperateException,java.lang.IllegalStateException
用途
論理あて先を停止します。
戻り値
OperateException：
停止処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先を停止するには、論理あて先に対する表示権限および管理権限が必要です。
public void
changeDevice(LogicalDevice device)
throws OperateException, java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理あて先に対応付けされている出力先（論理デバイス）を切り替えます。
論理あて先の出力先として切り替えできる論理あて先の論理あて先タイプと、論理デバイスの出力方法の関係を、以下の表に示しま
す。
出力先を切り替える論理あて先の論
理あて先タイプ
帳票配信用
切り替え先として指定できる論理デバイスの出力方法
帳票配信型の場合のプリンタ（印刷）
帳票配信型の場合のFAX（FAX送信）
帳票配信型の場合のList Works（電子保存(Interstage List
Manager互換のための機能)）
帳票配信型の場合のPDF（PDFファイル保存）
Web手元印刷用
Web手元印刷型の場合のPDF（PDFファイル）
Web手元印刷型の場合のOWF（OWFファイル）
- 63 -
パラメータ
device：
切り替え先の出力先（論理デバイス）を指定します。
例外
OperateException：
・出力先を切り替える論理あて先が存在しなかった場合
・切り替え処理でエラーが発生した場合
・ List Managerが開始されていない状態の場合
・切り替えを行う論理あて先に、以下の出力状態の帳票が存在した場合
－出力エラー
－応答待ち
－出力中
－出力待ち
－出力保留
－配信中
－配信待ち
java.lang.Illegal ArgumentException：
deviceパラメータに「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先に対応付けされている出力先（論理デバイス）を切り替えるには、論理あて先に対する表示権限および管理権限が必
要です。
備考
・論理あて先を停止した状態で、論理あて先の出力先（論理デバイス）を切り替えることを推奨します。
public Form
getForm(java.lang.String formID)
throws OperateException, java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票IDを指定して、論理あて先内の帳票を取得します。
パラメータ
formID：
取得する帳票の帳票IDを指定します。
帳票IDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することはできません。
- 64 -
戻り値
帳票
なお、該当する帳票がない場合は、「null」が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定した帳票IDが「null」の場合
・指定した帳票IDに「クエスチョンマーク（?）」または「アスタリスク（*）」が含まれている場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索し
た論理あて先名）が更新されます。
public Form[]
getForms(SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理あて先内の帳票を取得します。
パラメータ
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
帳票の配列
なお、論理あて先内に帳票がない場合は、長さ0の配列が取得されます。
- 65 -
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索し
た論理あて先名）が更新されます。
public ListResult
getForms(SortOrder[] sortOrder,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
最大取得件数を指定して、論理あて先内の帳票を取得します。
最大取得件数は、取得する帳票の最大数です。
帳票を取得した結果は、ListResultクラスのgetListメソッドの戻り値をForm[]にキャストして取得します。
パラメータ
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
resultLimit：
帳票の最大取得件数を指定します。
「0」以下の値を指定した場合は無制限になります。
戻り値
一覧で取得した結果
- 66 -
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6 個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索し
た論理あて先名）が更新されます。
public Form[]
getForms(FormFilterCondition condition,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票の絞り込み条件を指定して、論理あて先内の帳票を取得します。
パラメータ
condition：
帳票を絞り込んで検索するときの条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致した帳票の配列
なお、論理あて先内に帳票がない場合、または条件に一致する帳票がない場合は、長さ0の配列が取得されます。
- 67 -
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索し
た論理あて先名）が更新されます。
public ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票の絞り込み条件、および最大取得件数を指定して、論理あて先内の帳票を取得します。
最大取得件数は、取得する帳票の最大数です。
帳票を取得した結果は、ListResultクラスのgetListメソッドの戻り値をForm[]にキャストして取得します。
パラメータ
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
- 68 -
resultLimit：
帳票の最大取得件数を指定します。
「0」以下の値を指定した場合は無制限になります。
戻り値
一覧で取得した結果
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6 個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/検索し
た論理あて先名）が更新されます。
public ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して、論理あて先内の帳票を取得します。
最大取得件数は取得する帳票の最大数です。
帳票を取得した結果は、ListResult クラスのgetList メソッドの戻り値をForm[] にキャスト
して取得します。
パラメータ
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
- 69 -
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定
したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
startPosition：
部分取得する際の取得開始位置を指定します。
「0」以下を指定した場合は先頭から取得します（「1」を指定した場合と同じです)。
帳票一覧取得時に指定する絞り込み条件（condition)に一致するこの論理あて先に出力された帳票の件数より大きい値を指定した
場合は、取得件数が0件になります。
resultLimit：
最大取得件数を指定します。「0」以下を指定した場合は無制限に取得します。帳票一覧取得時に指定する絞り込み条件（condition)
に一致するこの論理あて先に出力された帳票の件数より大きい値を指定した場合は、絞り込み条件に一致するこの論理あて先に
出力された帳票の件数分だけ取得し、例外は発生しません。
戻り値
論理あて先内の帳票一覧
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を取得するには、論理あて先に対する表示権限が必要です。
備考
・このメソッドで帳票を取得すると、LMUserInfo クラスのgetLastViewLD メソッドで取得できる値（ユーザが最後に帳票を取得/ 検索
した論理あて先名）が更新されます。
public int
getFormsCount(FormFilterCondition condition)
throws OperateException, java.lang.IllegalStateException
- 70 -
用途
帳票の絞り込み条件を指定して、指定した条件に一致する帳票の総件数を取得します。
パラメータ
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
戻り値
指定した条件に一致する帳票の総件数
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public void
resumeAllForms(boolean isContinue)
throws OperateAllFormsException,java.lang.IllegalStateException
用途
論理あて先内の帳票の出力を一括して保留解除します。
帳票の出力状態が「出力保留」の帳票に対して、帳票の出力の保留を解除して帳票を出力します。
帳票の出力状態が「出力保留」以外の帳票に対しては無効です。
パラメータ
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・ List Managerが開始されていない状態の場合
- 71 -
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票の出力を一括して保留解除するには、論理あて先に対する表示権限および操作権限が必要です。
備考
・帳票の出力状態が「出力保留」の帳票が論理あて先内に存在しない場合、例外は発生しません。
public void
resumeAllForms(boolean isContinue,LMParametersList printoutOptions)
throws OperateAllFormsException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
印刷部数、メッセージ通知先を指定して、論理あて先内の帳票の出力を一括して保留解除します。
パラメータ
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
printoutOptions：
印刷部数、メッセージ通知先を、LMParameterKeyクラスの以下のキーで指定します。
－ PARAM_PRINTOUT_COPY（印刷部数）
帳票出力時の印刷部数をIntegerオブジェクトで指定します。
指定可能な印刷部数は1～ 999の範囲です。
- 「0」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプ
リケーションで指定した印刷部数が有効になります。
- 印刷部数を指定しなかった場合は、「0」が指定されたとみなされます。
－ PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
－ PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
通知メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・ List Manager が開始されていない状態の場合
- 72 -
java.lang.Illegal ArgumentException：
・ printoutOptionsパラメータの各キーに「null」が指定された場合
・ printoutOptions パラメータに指定できないキーを指定した場合
・ printoutOptions パラメータに有効なキーが存在しない場合
・印刷部数の値として、Integerオブジェクト以外が指定された場合
・印刷部数に0～999以外の値を指定した場合
・メッセージ通知先の値としてStringオブジェクト以外を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票の出力を一括して保留解除するには、論理あて先に対する表示権限および操作権限が必要です。
・出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項については、以下を参照してください。
⇒“●出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項”
・出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項ついては、以下を参照してください。
⇒“●出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項”
・ printoutOptionsパラメータに「null」を指定した場合は、印刷部数に「0」が指定されたとみなされ、メッセージ通知先は帳票登録時
のメッセージ通知先となります。
備考
・帳票の出力状態が「出力保留」の帳票が論理あて先内に存在しない場合、例外は発生しません。
・メッセージ通知先に、複数の通知先を指定することはできません。
public void
cancelAllForms(boolean isContinue)
throws OperateAllFormsException,java.lang.IllegalStateException
用途
論理あて先内の帳票の出力を一括して中止します。
論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。
帳票の出力中止が完了すると、帳票の出力状態が「中止」に変更されます。
パラメータ
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
- 73 -
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・帳票出力サーバと通信できない状態で、すでに帳票出力サーバに配信済みの帳票に対して、この指定を実行した場合
・ List Managerが開始されていない状態の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票の出力を一括して中止するには、論理あて先に対する表示権限および操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。
備考
・帳票出力サーバの環境設定ファイルのTcpReqIntervalキーに指定した値により、帳票の出力中止が完了しても帳票の出力状態が
すぐに更新されない場合があります。
public void
forceCancelAllForms(boolean isContinue)
throws OperateAllFormsException,java.lang.IllegalStateException
用途
論理あて先内の帳票の出力を、一括して強制的に中止します。
論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。
パラメータ
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・ List Managerが開始されていない状態の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
- 74 -
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票の出力を一括して強制的に中止するには、論理あて先に対する表示権限および操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。
備考
・出力の強制中止を行った場合、帳票出力サーバにおける出力状況、帳票出力サーバとの通信状態にかかわらず、List Manager
管理データベース上の帳票の出力状態を強制的に「中止」にします。そのため、帳票出力サーバに配信中、または帳票出力サー
バで出力中の帳票はそのまま処理が続行される場合があります。
public void
deleteAllForms(boolean isContinue)
throws OperateAllFormsException,java.lang.IllegalStateException
用途
論理あて先内の帳票を一括して削除します。
パラメータ
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・ List Managerが開始されていない状態の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を一括して削除するには、論理あて先に対する表示権限および操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。
public void
- 75 -
copyAllForms(java.lang.String toLogicalDestinationName,boolean isOutput,boolean isContinue)
throws OperateAllFormsException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理あて先内の帳票を一括して複写します。
複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
パラメータ
toLogicalDestination：
複写先の論理あて先名を指定します。
論理あて先グループを複写先論理あて先にすることはできません。
isOutput：
複写後に、帳票を出力するかどうかを指定します。
true：
帳票を出力する場合に指定します。
false：
帳票を出力しない場合に指定します。
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・複写元論理あて先または複写先論理あて先が存在しない場合
・複写元論理あて先と複写先論理あて先に同じ論理あて先を指定した場合
・複写先に、異なる論理あて先タイプの論理あて先を指定した場合
・ List Managerが開始されていない状態の場合
・ Web手元印刷型の場合で、以下の条件をすべて満たすとき
－ Web手元印刷（OWFファイル）用の論理あて先に対し、複写と同時に出力を行った（isOutputパラメータに「true」を指定した場
合）
－複写元と複写先で、帳票を出力するフォルダが同一である
－複写元の帳票が出力先のフォルダに存在する
・複写する帳票が1つも存在しなかった場合
・複写先論理あて先に論理あて先グループを指定した場合
java.lang.Illegal ArgumentException：
複写先の論理あて先名が「null」の場合
- 76 -
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を一括して複写するには、複写元論理あて先および複写先論理あて先の両方に、論理あて先に対する表示
権限および操作権限が必要です。
備考
・複写できる帳票が論理あて先内に存在しない場合、例外は発生しません。
・複写先論理あて先に、すでに同じ帳票が存在していた場合は複写されません。
複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）は、複写先論理あて先の帳票が出力されます。複
写元論理あて先の帳票は出力されません。複写元の帳票の出力状態にかかわらず、複写が正常に行われた帳票の出力状態の
初期状態は「登録」となります。
・論理あて先の論理あて先タイプがWeb手元印刷用の場合、以下のようになります。
－帳票の登録時に出力ファイル名を指定した場合、帳票の複写時には、登録時に指定した出力ファイル名が引き継がれます。
このため、複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）、複写元の帳票の出力ファイル名で
出力されます。
－複写元の論理あて先に対応付けされている論理デバイスの出力方法と、複写先の論理あて先に対応付けされている論理デ
バイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
public void
copyAllForms(java.lang.String toLogicalDestinationName,
boolean isOutput,boolean isContinue,LMParametersList printoutOptions)
throws OperateAllFormsException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
論理あて先内の帳票の出力を一括して複写します。
複写と同時に出力を行う場合、印刷部数、メッセージ通知先を指定します。
複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
パラメータ
toLogicalDestination Name：
複写先の論理あて先名を指定します。
論理あて先グループを複写先論理あて先にすることはできません。
isOutput：
複写後に、複写した帳票の出力を行うかどうかを指定します。
true：
複写後に帳票を出力する場合に指定します。
false：
複写後に帳票を出力しない場合に指定します。
isContinue：
処理中にエラーが発生した場合、その帳票をスキップして次の帳票を処理するかどうかを指定します。
- 77 -
true：
エラーが発生した帳票をスキップして、次の帳票を処理する場合に指定します。
false：
エラーが発生した時点で、処理を終了する場合に指定します。
printoutOptions：
印刷部数、メッセージ通知先を、LMParameterKeyクラスの以下のキーで指定します。複写と同時に出力を行った場合（isOutput パ
ラメータに「true」を指定した場合）に有効になります。
－ PARAM_PRINTOUT_COPY（印刷部数）
帳票出力時の印刷部数をIntegerオブジェクトで指定します。
指定可能な印刷部数は1～ 999の範囲です。
- 「0」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプ
リケーションで指定した印刷部数が有効になります。
- 印刷部数を指定しなかった場合は、「0」が指定されたとみなされます。
－ PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
－ PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
通知メッセージの通知先として、「ホスト名」または「IPアドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
例外
OperateAllForms Exception：
・一括処理でエラーが発生した場合
・複写元論理あて先または複写先論理あて先が存在しない場合
・複写元論理あて先と複写先論理あて先に同じ論理あて先を指定した場合
・複写先に、異なる論理あて先タイプの論理あて先を指定した場合
・ List Managerが開始されていない状態の場合
・ Web手元印刷型の場合で、以下の条件をすべて満たすとき
－ Web手元印刷（OWFファイル）用の論理あて先に対し、複写と同時に出力を行った（isOutputパラメータに「true」を指定した場
合）
－複写元と複写先で、帳票を出力するフォルダが同一である
－複写元の帳票が出力先のフォルダに存在する
・複写する帳票が1つも存在しなかった場合
・複写先論理あて先に論理あて先グループを指定した場合
java.lang.Illegal ArgumentException：
・複写先の論理あて先名が「null」の場合
・ printoutOptionsパラメータの各キーに「null」が指定された場合
・ printoutOptions パラメータに指定できないキーを指定した場合
・ printoutOptions パラメータに有効なキーが存在しない場合
・印刷部数の値として、Integerオブジェクト以外が指定された場合
・印刷部数に0～999以外の値を指定した場合
・メッセージ通知先の値としてStringオブジェクト以外を指定した場合
- 78 -
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・論理あて先内の帳票を一括して複写するには、複写元論理あて先、および複写先論理あて先の両方に、論理あて先に対する表
示権限および操作権限が必要です。
・ printoutOptionsパラメータに「null」を指定した場合は、印刷部数に「0」が指定されたとみなされ、メッセージ通知先は帳票登録時
のメッセージ通知先となります。
備考
・複写できる帳票が論理あて先内に存在しない場合、例外は発生しません。
・複写先論理あて先に、すでに同じ帳票が存在していた場合は複写されません。
複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）は、複写先論理あて先の帳票が出力されます。複
写元論理あて先の帳票は出力されません。複写元の帳票の出力状態にかかわらず、複写が正常に行われた帳票の出力状態の
初期状態は「登録」となります。
・論理あて先の論理あて先タイプがWeb 手元印刷用の場合、以下のようになります。
－帳票の登録時に出力ファイル名を指定した場合、帳票の複写時には、登録時に指定した出力ファイル名が引き継がれます。
このため、複写と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）、複写元の帳票の出力ファイル名で
出力されます。
－複写元の論理あて先に対応付けされている論理デバイスの出力方法と、複写先の論理あて先に対応付けされている論理デ
バイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
・メッセージ通知先に、複数の通知先を指定することはできません。
3.7.3 LogicalDestinationFilterConditionクラス
論理あて先を検索するときの検索条件を指定するクラスです。
LogicalDestinationManagerクラスで使用します。
java.lang.Object
└com.fujitsu.listmanager.operate.LogicalDestinationFilterCondition
public class LogicalDestinationFilterCondition
extends java.lang.Object
ポイント
・検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカー
ド文字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われな
い場合があります。
・検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定して、
空白が設定されている情報を絞り込むことはできません。
3.7.3.1 フィールドの概要
LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールドを以下に示します。
LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド
- 79 -
定数
NOT_SPECIFIED
説明
条件を特定しない場合に指定します。
3.7.3.2 コンストラクタの概要
LogicalDestinationFilterConditionクラスのコンストラクタを以下に示します。
LogicalDestinationFilterConditionクラスのコンストラクタ
コンストラクタの概要
LogicalDestinationFilterCondition()
LogicalDestinationFilterConditionオブジェクトを生成します。
3.7.3.3 メソッドの概要
LogicalDestinationFilterConditionクラスのメソッドを以下に示します。
LogicalDestinationFilterConditionクラスのメソッド
メソッドの概要
java.lang.String
getName()
論理あて先の絞り込み条件として設定されている、論理あて先名を取得しま
す。
int
getType()
論理あて先の絞り込み条件として設定されている、論理あて先タイプを取得し
ます。
int
getPriority()
論理あて先の絞り込み条件として設定されている、優先度を取得します。
java.lang.String
getDeviceName()
論理あて先の絞り込み条件として設定されている、論理デバイス名を取得しま
す。
java.lang.String
getDeviceComment()
論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされ
ている論理デバイスのコメント（出力先）を取得します。
int[]
getOutputMethod()
論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされ
ている論理デバイスの出力方法を取得します。
java.lang.Boolean
getActive()
論理あて先の絞り込み条件として設定されている、論理あて先の状態を取得し
ます。
int
getErrorStatus()
論理あて先の絞り込み条件として設定されている、出力エラー状態を取得しま
す。
java.lang.String
getCustomizeItem1()
論理あて先の絞り込み条件として設定されている、カスタマイズ項目1を取得し
ます。
java.lang.String
getCustomizeItem2()
論理あて先の絞り込み条件として設定されている、カスタマイズ項目2を取得し
ます。
- 80 -
メソッドの概要
java.lang.String
getCustomizeItem3()
論理あて先の絞り込み条件として設定されている、カスタマイズ項目3を取得し
ます。
java.lang.String
getCustomizeItem4()
論理あて先の絞り込み条件として設定されている、カスタマイズ項目4を取得し
ます。
java.lang.String
getCustomizeItem5()
論理あて先の絞り込み条件として設定されている、カスタマイズ項目5を取得し
ます。
void
setName(java.lang.String name)
論理あて先の絞り込み条件として、論理あて先名を指定します。
void
setType(int type)
論理あて先の絞り込み条件として、論理あて先タイプを指定します。
void
setPriority(int priority)
論理あて先の絞り込み条件として、優先度を指定します。
void
setDeviceName(java.lang.String deviceName)
論理あて先の絞り込み条件として、論理デバイス名を指定します。
void
setDeviceComment(java.lang.String deviceComment)
論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバ
イスのコメント（出力先）を指定します。
void
setOutputMethod(int[] outputMethod)
論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバ
イスの出力方法を指定します。
void
setActive(java.lang.Boolean active)
論理あて先の絞り込み条件として、論理あて先の状態を指定します。
void
setErrorStatus(int errorStatus)
論理あて先の絞り込み条件として、出力エラー状態を指定します。
void
setCustomizeItem1(java.lang.String customizeItem1)
論理あて先の絞り込み条件として、カスタマイズ項目1を指定します。
void
setCustomizeItem2(java.lang.String customizeItem2)
論理あて先の絞り込み条件として、カスタマイズ項目2を指定します。
void
setCustomizeItem3(java.lang.String customizeItem3)
論理あて先の絞り込み条件として、カスタマイズ項目3を指定します。
void
setCustomizeItem4(java.lang.String customizeItem4)
論理あて先の絞り込み条件として、カスタマイズ項目4を指定します。
void
setCustomizeItem5(java.lang.String customizeItem5)
論理あて先の絞り込み条件として、カスタマイズ項目5を指定します。
ポイント
各論理あて先情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
- 81 -
3.7.3.4 コンストラクタの詳細
public
LogicalDestinationFilterCondition()
用途
LogicalDestinationFilterConditionオブジェクトを生成します。
3.7.3.5 メソッドの詳細
public java.lang.String
getName()
用途
論理あて先の絞り込み条件として設定されている、論理あて先名を取得します。
戻り値
論理あて先名
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public int
getType()
用途
論理あて先の絞り込み条件として設定されている、論理あて先タイプを取得します。
戻り値
LogicalDestinationクラスの論理あて先タイプを示すフィールド
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetTypeメソッドで取得されるフィールド”
なお、絞り込み条件が指定されていない場合は、「NOT_SPECIFIED」が取得されます。
「NOT_SPECIFIED」の詳細については、以下を参照してください。
⇒“LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド”
public int
getPriority()
用途
論理あて先の絞り込み条件として設定されている、優先度を取得します。
戻り値
優先度を示す数値1（優先度：低）～10（優先度：高）
なお、絞り込み条件が指定されていない場合は、「NOT_SPECIFIED」が取得されます。
「NOT_SPECIFIED」の詳細については、以下を参照してください。
⇒“LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド”
- 82 -
public java.lang.String
getDeviceName()
用途
論理あて先の絞り込み条件として設定されている、論理デバイス名を取得します。
戻り値
論理デバイス名
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getDeviceComment()
用途
論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされている論理デバイスのコメント（出力先）を取得します。
戻り値
コメント（出力先）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public int[]
getOutputMethod()
用途
論理あて先の絞り込み条件として設定されている、論理あて先に対応付けされている論理デバイスの出力方法を取得します。
戻り値
LogicalDeviceクラスの出力方法を示すフィールドの配列
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.Boolean
getActive()
用途
論理あて先の絞り込み条件として設定されている、論理あて先の状態を取得します。
戻り値
Boolean.TRUE（プリミティブ値trueに対応するBooleanオブジェクト）：
「起動中」が条件の場合
- 83 -
Boolean.FALSE（プリミティブ値falseに対応するBooleanオブジェクト）：
「停止中」が条件の場合
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public int
getErrorStatus()
用途
論理あて先の絞り込み条件として設定されている、出力エラー状態を取得します。
戻り値
LogicalDestinationクラスの出力エラー状態を示すフィールド
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestination クラスのgetErrorStatus メソッドで取得されるフィールド”
なお、絞り込み条件が指定されていない場合は、「NOT_SPECIFIED」が取得されます。
「NOT_SPECIFIED」の詳細については、以下を参照してください。
⇒“LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド”
public java.lang.String
getCustomizeItem1()
用途
論理あて先の絞り込み条件として設定されている、カスタマイズ項目1を取得します。
戻り値
カスタマイズ項目1
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem2()
用途
論理あて先の絞り込み条件として設定されている、カスタマイズ項目2を取得します。
戻り値
カスタマイズ項目2
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem3()
用途
論理あて先の絞り込み条件として設定されている、カスタマイズ項目3を取得します。
- 84 -
戻り値
カスタマイズ項目3
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem4()
用途
論理あて先の絞り込み条件として設定されている、カスタマイズ項目4を取得します。
戻り値
カスタマイズ項目4
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem5()
用途
論理あて先の絞り込み条件として設定されている、カスタマイズ項目5を取得します。
戻り値
カスタマイズ項目5
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public void
setName(java.lang.String name)
用途
論理あて先の絞り込み条件として、論理あて先名を指定します。
パラメータ
name：
論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setType(int type)
throws java.lang.IllegalArgumentException
用途
論理あて先の絞り込み条件として、論理あて先タイプを指定します。
- 85 -
パラメータ
type：
LogicalDestinationクラスの論理あて先タイプを示すフィールドを指定します。
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestinationクラスのgetTypeメソッドで取得されるフィールド”
この条件で絞り込みを行わない場合は、「NOT_SPECIFIED」を指定します。
「NOT_SPECIFIED」の詳細については、以下を参照してください。
⇒“LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド”
例外
java.lang.Illegal ArgumentException：
無効な論理あて先タイプを指定した場合
public void
setPriority(int priority)
throws java.lang.IllegalArgumentException
用途
論理あて先の絞り込み条件として、優先度を指定します。
パラメータ
priority：
優先度を示す数値1（優先度：低）～10（優先度：高）を指定します。
この条件で絞り込みを行わない場合は、「NOT_SPECIFIED」を指定します。
「NOT_SPECIFIED」の詳細については、以下を参照してください。
⇒“LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド”
例外
java.lang.Illegal ArgumentException：
無効な優先度を指定した場合
public void
setDeviceName(java.lang.String deviceName)
用途
論理あて先の絞り込み条件として、論理デバイス名を指定します。
パラメータ
deviceName：
論理デバイス名を指定します。
論理デバイス名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 86 -
public void
setDeviceComment(java.lang.String deviceComment)
用途
論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバイスのコメント（出力先）を指定します。
パラメータ
deviceComment：
論理あて先に対応付けされている論理デバイスのコメント（出力先）を指定します。
コメントの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setOutputMethod(int[] outputMethod)
throws java.lang.IllegalArgumentException
用途
論理あて先の絞り込み条件として、論理あて先に対応付けされている論理デバイスの出力方法を指定します。
パラメータ
outputMethod：
LogicalDeviceクラスの出力方法を示すフィールドを指定します。出力方法は複数指定できます。複数指定した場合は論理和条件
（OR条件）となります。
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”
この条件で絞り込みを行わない場合は、「null」を指定します。
例外
java.lang.Illegal ArgumentException：
・無効な出力方法を指定した場合
・同じ出力方法を複数指定した場合
public void
setActive(java.lang.Boolean active)
用途
論理あて先の絞り込み条件として、論理あて先の状態を指定します。
パラメータ
active：
論理あて先の状態を指定します。
Boolean.TRUE（プリミティブ値trueに対応するBooleanオブジェクト）：
「起動中」の論理あて先を絞り込む場合に指定します。
- 87 -
Boolean.FALSE（プリミティブ値falseに対応するBooleanオブジェクト）：
「停止中」の論理あて先を絞り込む場合に指定します。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setErrorStatus(int errorStatus)
throws java.lang.IllegalArgumentException
用途
論理あて先の絞り込み条件として、出力エラー状態を指定します。
パラメータ
errorStatus：
LogicalDestinationクラスの出力エラー状態を示すフィールドを指定します。
フィールドの詳細については、以下を参照してください。
⇒“LogicalDestination クラスのgetErrorStatus メソッドで取得されるフィールド”
この条件で絞り込みを行わない場合は、「NOT_SPECIFIED」を指定します。
「NOT_SPECIFIED」の詳細については、以下を参照してください。
⇒“LogicalDestinationFilterConditionクラスのメソッドで取得されるフィールド”
例外
java.lang.Illegal ArgumentException：
無効な出力エラー状態を指定した場合
public void
setCustomizeItem1(java.lang.String customizeItem1)
用途
論理あて先の絞り込み条件として、カスタマイズ項目1を指定します。
パラメータ
customizeItem1：
カスタマイズ項目1を指定します。
カスタマイズ項目1の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem2(java.lang.String customizeItem2)
用途
論理あて先の絞り込み条件として、カスタマイズ項目2を指定します。
- 88 -
パラメータ
customizeItem2：
カスタマイズ項目2を指定します。
カスタマイズ項目2の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem3(java.lang.String customizeItem3)
用途
論理あて先の絞り込み条件として、カスタマイズ項目3を指定します。
パラメータ
customizeItem3：
カスタマイズ項目3を指定します。
カスタマイズ項目3の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem4(java.lang.String customizeItem4)
用途
論理あて先の絞り込み条件として、カスタマイズ項目4を指定します。
パラメータ
customizeItem4：
カスタマイズ項目4を指定します。
カスタマイズ項目4の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem5(java.lang.String customizeItem5)
用途
論理あて先の絞り込み条件として、カスタマイズ項目5を指定します。
パラメータ
customizeItem5：
カスタマイズ項目5を指定します。
カスタマイズ項目5の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 89 -
3.8 クラスの詳細（論理デバイス関連）
論理デバイスに関するクラスの詳細について説明します。
3.8.1 LogicalDeviceManagerクラス
論理デバイスの取得/検索を行うクラスです。
java.lang.Object
└com.fujitsu.listmanager.operate.LogicalDeviceManager
public class LogicalDeviceManager
extends java.lang.Object
3.8.1.1 コンストラクタの概要
LogicalDeviceManagerクラスのコンストラクタを以下に示します。
LogicalDeviceManagerクラスのコンストラクタ
コンストラクタの概要
LogicalDeviceManager()
LogicalDeviceManagerクラスのLogicalDeviceManagerオブジェクトを生成します。
LogicalDeviceManager(LMUser user)
LogicalDeviceManagerクラスのLogicalDeviceManagerオブジェクトを生成します。
セキュリティモード有効時に、このコンストラクタを使用します。
3.8.1.2 メソッドの概要
LogicalDeviceManagerクラスのメソッドを以下に示します。
LogicalDeviceManagerクラスのメソッド
メソッドの概要
LogicalDevice[]
getLogicalDevices(SortOrder[] sortOrder)
すべての論理デバイスを取得します。
LogicalDevice[]
getLogicalDevices(LogicalDeviceFilterCondition condition,SortOrder[]
sortOrder)
論理デバイスの絞り込み条件を指定して、論理デバイスを取得します。
ポイント
論理デバイスの定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.8.1.3 コンストラクタの詳細
public
LogicalDeviceManager()
throws java.lang.IllegalStateException
- 90 -
用途
LogicalDeviceManagerクラスのLogicalDeviceManagerオブジェクトを生成します。
例外
java.lang.Illegal StateException：
セキュリティモード有効時
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public
LogicalDeviceManager(LMUser user)
throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
LogicalDeviceManagerクラスのLogicalDeviceManagerオブジェクトを生成します。
セキュリティモード有効時に、このコンストラクタを使用します。
パラメータ
user：
UserAuthorization クラスまたはLMUserManager クラスで取得したユーザを指定します。
例外
java.lang.Illegal ArgumentException：
userに「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
3.8.1.4 メソッドの詳細
public LogicalDevice[]
getLogicalDevices(SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
すべての論理デバイスを取得します。
パラメータ
sortOrder：
取得した論理デバイスをソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
- 91 -
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
論理デバイスの配列
なお、該当する論理デバイスがない場合は、長さ0の配列が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public LogicalDevice[]
getLogicalDevices(LogicalDeviceFilterCondition condition,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理デバイスの絞り込み条件を指定して、論理デバイスを取得します。
パラメータ
condition：
論理デバイスを絞り込んで、論理デバイスを検索するときの検索条件を指定します。
論理デバイスの絞り込み条件については、以下を参照してください。
⇒“3.8.3 LogicalDeviceFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した論理デバイスをソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致した論理デバイスの配列
なお、条件に一致する論理デバイスがない場合は、長さ0の配列が取得されます。
- 92 -
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
3.8.2 LogicalDeviceクラス
論理デバイス情報を取得するクラスです。
java.lang.Object
└com.fujitsu.listmanager.operate.LogicalDevice
public class LogicalDevice
extends java.lang.Object
3.8.2.1 フィールドの概要
LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールドを以下に示します。
LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド
定数
説明
OUTPUT_PRINTER_DOCUMENT_P
USH
出力方法は、帳票配信型の場合のプリンタ（印刷）です。
OUTPUT_FAX_DOCUMENT_PUSH
出力方法は、帳票配信型の場合のFAX（FAX送信）です。
OUTPUT_LISTWORKS_
DOCUMENT_PUSH
出力方法は、帳票配信型の場合のList Works（電子保存(Interstage
List Manager互換のための機能)）です。
OUTPUT_PDF_DOCUMENT_PUSH
出力方法は、帳票配信型の場合のPDF（PDFファイル保存）です。
OUTPUT_PDF_LOCAL_PRINT
出力方法は、Web手元印刷型の場合のPDF（PDFファイル）です。
OUTPUT_OWF_LOCAL_PRINT
出力方法は、Web手元印刷型の場合のOWF（OWFファイル）で
す。
LogicalDeviceクラスのgetPositionTypeメソッドで取得されるフィールドを以下に示します。
LogicalDeviceクラスのgetPositionTypeメソッドで取得されるフィールド
定数
説明
POSITION_TYPE_INCH
原点位置指定単位は、インチです。
POSITION_TYPE_MM
原点位置指定単位は、ミリメートルです。
POSITION_TYPE_UNKNOWN
原点位置指定単位は、未指定です。
- 93 -
LogicalDeviceクラスのgetDisplayMessageModeメソッドで取得されるフィールドを以下に示します。
このフィールドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
LogicalDeviceクラスのgetDisplayMessageModeメソッドで取得されるフィールド
定数
説明
DISPLAY_MESSAGE_AUTO
用紙交換メッセージ表示指定は、「用紙変更時に自動で表示しな
い」です。
DISPLAY_MESSAGE_NECESSARY
用紙交換メッセージ表示指定は、「印刷開始時に必ず表示する」
です。
DISPLAY_MESSAGE_NONE
用紙交換メッセージ表示指定は、「表示しない」です。
DISPLAY_MESSAGE_USE_FORM_
ATTRIBUTE
用紙交換メッセージ表示指定は、「帳票属性の編集コマンド
（lmedtformatrコマンド）で定義した用紙交換メッセージ表示指定に
したがう」です。
3.8.2.2 メソッドの概要
LogicalDeviceクラスのメソッドを以下に示します。
LogicalDeviceクラスのメソッド
メソッドの概要
java.lang.String
getName()
論理デバイス名を取得します。
int
getOutputMethod()
論理デバイスの出力方法を取得します。
java.lang.String
getHostName()
論理デバイスの通信対象コンピュータ名を取得します。
java.lang.String
getDeviceName()
論理デバイスの印刷プリンタ名を取得します。
java.lang.String
getOutputFolder()
論理デバイスの出力フォルダを取得します。
java.lang.String
getDbPath()
論理デバイスに定義されている、電子保存時の保管フォルダのパスを取得しま
す。
本メソッドは、Interstage List Manager互換のための機能で使用します。
int
getPositionType()
論理デバイスの原点位置指定単位を取得します。
float
getPositionY()
論理デバイスの原点位置縦方向を取得します。
float
getPositionX()
論理デバイスの原点位置横方向を取得します。
java.lang.String
getComment()
論理デバイスのコメント（出力先）を取得します。
java.lang.String
getDivision()
論理デバイスの論理デバイス区分を取得します。
- 94 -
メソッドの概要
int
getDisplayMessageMode()
用紙交換メッセージ表示指定を取得します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポー
トしています。
java.lang.String
getSendMessageHostName()
メッセージ通知先を取得します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポー
トしています。
java.lang.String
getPdfAttributeFileName()
帳票出力時に使用するPDF文書情報ファイル名を取得します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポー
トしています。
java.lang.String
getFaxAttributeFileName()
帳票出力時に使用するFAX配信属性ファイル名を取得します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポー
トしています。
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を取得します。
ポイント
各論理デバイス情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.8.2.3 メソッドの詳細
public java.lang.String
getName()
- 95 -
用途
論理デバイス名を取得します。
戻り値
論理デバイス名
public int
getOutputMethod()
用途
論理デバイスの出力方法を取得します。
戻り値
出力方法を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”
public java.lang.String
getHostName()
用途
論理デバイスの通信対象コンピュータ名を取得します。
以下のどれかが取得されます。
・プリンタ（FAX装置および電子保存装置(Interstage List Manager互換のための機能で使用する装置)も含む）が定義されている接
続先の「ホスト名」または「IPアドレス」
・ PDFファイルを格納する接続先の「ホスト名」または「IPアドレス」
戻り値
通信対象コンピュータ名
なお、通信対象コンピュータ名が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public java.lang.String
getDeviceName()
用途
論理デバイスの印刷プリンタ名を取得します。
印刷プリンタ名は、帳票出力サーバに接続されている印刷プリンタ名です。なお、印刷プリンタには、FAX装置および電子保存装置
(Interstage List Manager互換のための機能で使用する装置)も含まれます。
戻り値
印刷プリンタ名
なお、プリンタ名が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
- 96 -
public java.lang.String
getOutputFolder()
用途
論理デバイスの出力フォルダを取得します。
出力フォルダは、出力方法が「帳票配信型の場合のPDF（PDFファイル保存）」、「Web手元印刷型の場合のPDF（PDFファイル）」、お
よび「Web手元印刷型の場合のOWF（OWFファイル）」の場合のフォルダ名です。
戻り値
出力フォルダ名
なお、論理デバイスの出力フォルダが指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public java.lang.String
getDbPath()
本メソッドは、出力方法に電子保存(Interstage List Manager互換のための機能)を指定する場合に使用します。
用途
論理デバイスに定義されている、電子保存時の保管フォルダのパスを取得します。
保管フォルダのパスは、帳票を電子保存するリスト管理サーバ上の保管フォルダのディレクトリ名です。
戻り値
電子保存時の保管フォルダパス名
なお、電子保存時の保管フォルダパス名が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public int
getPositionType()
用途
論理デバイスの原点位置指定単位を取得します。
帳票配信型の場合に、有効な値を取得することができます。
戻り値
原点位置指定単位を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetPositionTypeメソッドで取得されるフィールド”
public float
getPositionY()
用途
論理デバイスの原点位置縦方向を取得します。
帳票配信型の場合に、有効な値を取得することができます。
- 97 -
原点位置縦方向は、帳票出力時の縦方向からの原点位置です。
戻り値
原点位置縦方向
なお、原点位置縦方向が指定されていない場合は、「0」が取得されます。
public float
getPositionX()
用途
論理デバイスの原点位置横方向を取得します。
帳票配信型の場合に、有効な値を取得することができます。
原点位置横方向は、帳票出力時の横方向からの原点位置です。
戻り値
原点位置横方向
なお、原点位置横方向指定されていない場合は、「0」が取得されます。
public java.lang.String
getComment()
用途
論理デバイスのコメント（出力先）を取得します。
戻り値
コメント（出力先）
なお、コメント（出力先）が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public java.lang.String
getDivision()
用途
論理デバイスの論理デバイス区分を取得します。
論理デバイス区分は、論理デバイスを分類するための区分です。
戻り値
論理デバイス区分
なお、論理デバイス区分が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public int
getDisplayMessageMode()
- 98 -
用途
用紙交換メッセージ表示指定を取得します。
出力方法が「帳票配信型の場合のプリンタ（印刷）」の場合に有効となります。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
戻り値
用紙交換メッセージの表示方法を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetDisplayMessageModeメソッドで取得されるフィールド”
public java.lang.String
getSendMessageHostName()
用途
メッセージ通知先を取得します。
メッセージ通知先は、通知メッセージを通知するコンピュータを示します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
戻り値
メッセージ通知先の「ホスト名」または「IPアドレス」
メッセージ通知先が設定されていない場合、または半角空白だけの場合は「null」が取得されます。
public java.lang.String
getPdfAttributeFileName()
用途
帳票出力時に使用するPDF文書情報ファイル名を取得します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
戻り値
帳票出力時に使用するPDF文書情報ファイルのフルパス
PDF文書情報ファイル名が設定されていない場合、または半角空白だけの場合は「null」が取得されます。
public java.lang.String
getFaxAttributeFileName()
用途
帳票出力時に使用するFAX配信属性ファイル名を取得します。
このメソッドは、ホスト帳票連携機能を利用して帳票を配信する場合のみサポートしています。
戻り値
帳票出力時に使用するFAX配信属性ファイルのフルパス
FAX配信属性ファイル名が設定されていない場合、または半角空白だけの場合は「null」が取得されます。
- 99 -
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
- 100 -
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」が取得されます。
3.8.3 LogicalDeviceFilterConditionクラス
論理デバイスを検索するときの検索条件を指定するクラスです。
LogicalDeviceManagerクラスで使用します。
- 101 -
java.lang.Object
└com.fujitsu.listmanager.operate.LogicalDeviceFilterCondition
public class LogicalDeviceFilterCondition
extends java.lang.Object
ポイント
・検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカー
ド文字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われな
い場合があります。
・検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定して、
空白が設定されている情報を絞り込むことはできません。
3.8.3.1 コンストラクタの概要
LogicalDeviceFilterConditionクラスのコンストラクタを以下に示します。
LogicalDeviceFilterConditionクラスのコンストラクタ
コンストラクタの概要
LogicalDeviceFilterCondition()
LogicalDeviceFilterConditionオブジェクトを生成します。
3.8.3.2 メソッドの概要
LogicalDeviceFilterConditionクラスのメソッドを以下に示します。
LogicalDeviceFilterConditionクラスのメソッド
メソッドの概要
java.lang.String
getName()
論理デバイスの絞り込み条件として設定されている、論理デバイス名を取得し
ます。
int[]
getOutputMethod()
論理デバイスの絞り込み条件として設定されている、出力方法を取得します。
java.lang.String
getHostName()
論理デバイスの絞り込み条件として設定されている、通信対象コンピュータ名
を取得します。
java.lang.String
getComment()
論理デバイスの絞り込み条件として設定されている、コメント（出力先）を取得し
ます。
java.lang.String
getDivision()
論理デバイスの絞り込み条件として設定されている、論理デバイス区分を取得
します。
java.lang.String
getCustomizeItem1()
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目1を取得
します。
- 102 -
メソッドの概要
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を取得
します。
void
setName(java.lang.String name)
論理デバイスの絞り込み条件として、論理デバイス名を指定します。
void
setOutputMethod(int[] outputMethod)
論理デバイスの絞り込み条件として、出力方法を指定します。
void
setHostName(java.lang.String hostName)
論理デバイスの絞り込み条件として、通信対象コンピュータ名を指定します。
void
setComment(java.lang.String comment)
論理デバイスの絞り込み条件として、コメント（出力先）を指定します。
void
setDivision(java.lang.String division)
論理デバイスの絞り込み条件として、論理デバイス区分を指定します。
void
setCustomizeItem1(java.lang.String customizeItem1)
論理デバイスの絞り込み条件として、カスタマイズ項目1を指定します。
void
setCustomizeItem2(java.lang.String customizeItem2)
論理デバイスの絞り込み条件として、カスタマイズ項目2を指定します。
void
setCustomizeItem3(java.lang.String customizeItem3)
論理デバイスの絞り込み条件として、カスタマイズ項目3を指定します。
void
setCustomizeItem4(java.lang.String customizeItem4)
論理デバイスの絞り込み条件として、カスタマイズ項目4を指定します。
void
setCustomizeItem5(java.lang.String customizeItem5)
論理デバイスの絞り込み条件として、カスタマイズ項目5を指定します。
- 103 -
メソッドの概要
void
setCustomizeItem6(java.lang.String customizeItem6)
論理デバイスの絞り込み条件として、カスタマイズ項目6を指定します。
void
setCustomizeItem7(java.lang.String customizeItem7)
論理デバイスの絞り込み条件として、カスタマイズ項目7を指定します。
void
setCustomizeItem8(java.lang.String customizeItem8)
論理デバイスの絞り込み条件として、カスタマイズ項目8を指定します。
ポイント
各論理デバイス情報の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.8.3.3 コンストラクタの詳細
public
LogicalDeviceFilterCondition()
用途
LogicalDeviceFilterConditionオブジェクトを生成します。
3.8.3.4 メソッドの詳細
public java.lang.String
getName()
用途
論理デバイスの絞り込み条件として設定されている、論理デバイス名を取得します。
戻り値
論理デバイス名
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public int[]
getOutputMethod()
用途
論理デバイスの絞り込み条件として設定されている、出力方法を取得します。
戻り値
LogicalDeviceクラスの出力方法を示すフィールドの配列
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
- 104 -
public java.lang.String
getHostName()
用途
論理デバイスの絞り込み条件として設定されている、通信対象コンピュータ名を取得します。
戻り値
通信対象コンピュータ名
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getComment()
用途
論理デバイスの絞り込み条件として設定されている、コメント（出力先）を取得します。
戻り値
コメント（出力先）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getDivision()
用途
論理デバイスの絞り込み条件として設定されている、論理デバイス区分を取得します。
戻り値
論理デバイス区分
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem1()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目1を取得します。
戻り値
カスタマイズ項目1
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem2()
- 105 -
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目2を取得します。
戻り値
カスタマイズ項目2
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem3()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目3を取得します。
戻り値
カスタマイズ項目3
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem4()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目4を取得します。
戻り値
カスタマイズ項目4
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem5()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目5を取得します。
戻り値
カスタマイズ項目5
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem6()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目6を取得します。
- 106 -
戻り値
カスタマイズ項目6
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem7()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目7を取得します。
戻り値
カスタマイズ項目7
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem8()
用途
論理デバイスの絞り込み条件として設定されている、カスタマイズ項目8を取得します。
戻り値
カスタマイズ項目8
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public void
setName(java.lang.String name)
用途
論理デバイスの絞り込み条件として、論理デバイス名を指定します。
パラメータ
name：
論理デバイス名を指定します。
論理デバイス名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setOutputMethod(int[] outputMethod)
throws java.lang.IllegalArgumentException
用途
論理デバイスの絞り込み条件として、出力方法を指定します。
- 107 -
パラメータ
outputMethod：
LogicalDeviceクラスの出力方法を示すフィールドを指定します。出力方法は複数指定できます。複数指定した場合は論理和条件
（OR条件）となります。
フィールドの詳細については、以下を参照してください。
⇒“LogicalDeviceクラスのgetOutputMethodメソッドで取得されるフィールド”
この条件で絞り込みを行わない場合は、「null」を指定します。
例外
java.lang.Illegal ArgumentException：
・無効な出力方法を指定した場合
・同じ出力方法を複数指定した場合
public void
setHostName(java.lang.String hostName)
用途
論理デバイスの絞り込み条件として、通信対象コンピュータ名を指定します。
パラメータ
hostName：
通信対象コンピュータ名を指定します。
通信対象コンピュータ名は、以下のいずれかを指定します。
－プリンタ（FAX装置および電子保存装置(Interstage List Manager互換のための機能で使用する装置)も含む）が定義されてい
る接続先の「ホスト名」または「IPアドレス」
－ PDFファイルを格納する接続先の「ホスト名」または「IPアドレス」
通信対象コンピュータ名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setComment(java.lang.String comment)
用途
論理デバイスの絞り込み条件として、コメント（出力先）を指定します。
パラメータ
comment：
コメント（出力先）を指定します。
コメントの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
- 108 -
setDivision(java.lang.String division)
用途
論理デバイスの絞り込み条件として、論理デバイス区分を指定します。
パラメータ
division：
論理デバイス区分を指定します。
論理デバイスを分類する場合に使用します。
論理デバイス区分の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem1(java.lang.String customizeItem1)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目1を指定します。
パラメータ
customizeItem1：
カスタマイズ項目1を指定します。
カスタマイズ項目1の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem2(java.lang.String customizeItem2)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目2を指定します。
パラメータ
customizeItem2：
カスタマイズ項目2を指定します。
カスタマイズ項目2の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem3(java.lang.String customizeItem3)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目3を指定します。
- 109 -
パラメータ
customizeItem3：
カスタマイズ項目3を指定します。
カスタマイズ項目3の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem4(java.lang.String customizeItem4)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目4を指定します。
パラメータ
customizeItem4：
カスタマイズ項目4を指定します。
カスタマイズ項目4の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem5(java.lang.String customizeItem5)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目5を指定します。
パラメータ
customizeItem5：
カスタマイズ項目5を指定します。
カスタマイズ項目5の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem6(java.lang.String customizeItem6)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目6を指定します。
パラメータ
customizeItem6：
カスタマイズ項目6を指定します。
カスタマイズ項目6の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 110 -
public void
setCustomizeItem7(java.lang.String customizeItem7)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目7を指定します。
パラメータ
customizeItem7：
カスタマイズ項目7を指定します。
カスタマイズ項目7の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem8(java.lang.String customizeItem8)
用途
論理デバイスの絞り込み条件として、カスタマイズ項目8を指定します。
パラメータ
customizeItem8：
カスタマイズ項目8を指定します。
カスタマイズ項目8の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
3.9 クラスの詳細（帳票関連）
帳票に関するクラスの詳細について説明します。
ポイント
情報を一覧取得するメソッドの実行時、メソッドが実行されるたびに最新の情報を取得します。
例えば、同じパラメータでメソッドを連続で実行した場合、メソッドの実行の間に情報が更新されていれば、取得される情報が違うもの
になる可能性があります。
3.9.1 FormManagerクラス
論理あて先を意識せずに、帳票の取得/検索や帳票属性の更新を行うクラスです。
論理あて先の表示権限を持たなくても、すべての論理あて先を対象にして、帳票を取得/検索することができます。
特定の論理あて先内の帳票だけを扱う場合は、その論理あて先名を引数に指定して検索します。帳票の検索条件は、FormFilterCondition
クラスを使用して指定します。
java.lang.Object
└com.fujitsu.listmanager.operate.FormManager
public class FormManager
extends java.lang.Object
- 111 -
ポイント
・検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカー
ド文字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われな
い場合があります。
・検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定して、
空白が設定されている情報を絞り込むことはできません。
3.9.1.1 コンストラクタの概要
FormManagerクラスのコンストラクタを以下に示します。
FormManagerクラスのコンストラクタ
コンストラクタの概要
FormManager(LMUser user)
FormManagerクラスのFormManagerオブジェクトを生成します。
3.9.1.2 メソッドの概要
FormManagerクラスのメソッドを以下に示します。
FormManagerクラスのメソッド
メソッドの概要
Form
getForm(java.lang.String formID)
帳票IDを指定して、帳票を取得します。
Form[]
getForms(FormFilterCondition condition,SortOrder[] sortOrder)
帳票の絞り込み条件を指定して、帳票を取得します。
ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int
resultLimit)
帳票の絞り込み条件、および最大取得件数を指定して、帳票を取得します。
Form[]
getForms(java.lang.String logicalDestination,FormFilterCondition
condition,SortOrder[] sortOrder)
検索対象にする論理あて先名、および帳票の絞り込み条件を指定して、帳票
を取得します。
ListResult
getForms(java.lang.String logicalDestination,FormFilterCondition
condition,SortOrder[] sortOrder,int resultLimit)
検索対象にする論理あて先名、帳票の絞り込み条件、および最大取得件数を
指定して、帳票を取得します。
ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int
startPosition,int resultLimit)
帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して部分的
な帳票の一覧を取得します。
ListResult
getForms(java.lang.String logicalDestination,FormFilterCondition
condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
論理あて先、帳票の絞り込み条件、取得開始位置、および最大取得件数を指
定して帳票を取得します。
- 112 -
メソッドの概要
int
getFormsCount(java.lang.String logicalDestination, FormFilterCondition
condition)
論理あて先、帳票の絞り込み条件を指定して、指定した条件に一致する帳票
の総件数を取得します。
void
update(java.lang.String formID, LMParametersList updateItems)
List Manager 管理データベースに管理されている帳票のカスタマイズ項目、業
務あて先を更新します。
ポイント
各帳票属性の定義については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.9.1.3 コンストラクタの詳細
public
FormManager(LMUser user)
throws java.lang.IllegalStateException
用途
FormManagerクラスのFormManagerオブジェクトを生成します。
パラメータ
user：
UserAuthorizationクラス、またはLMUserManagerクラスで取得したユーザを指定します。
例外
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
3.9.1.4 メソッドの詳細
public Form
getForm(java.lang.String formID)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票IDを指定して、帳票を取得します。
パラメータ
formID：
取得する帳票の帳票IDを指定します。
帳票IDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することはできません。
- 113 -
戻り値
帳票
なお、該当する帳票がない場合は、「null」が取得されます。
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・帳票IDが「null」の場合
・帳票IDに「クエスチョンマーク（?）」または「アスタリスク（*）」が含まれている場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public Form[]
getForms(FormFilterCondition condition,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票の絞り込み条件を指定して、帳票を取得します。
パラメータ
condition：
帳票を絞り込んで検索するときの条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致した帳票の配列
なお、条件に一致する帳票がない場合は、長さ0の配列が取得されます。
例外
Operate Exception：
取得処理でエラーが発生した場合
- 114 -
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票の絞り込み条件、および最大取得件数を指定して、帳票を取得します。
最大取得件数は、取得する帳票の最大数です。
取得した帳票は、ListResultクラスのgetListメソッドで取得します。getListメソッドの戻り値を、帳票の配列Form[]にキャストして取得しま
す。
パラメータ
condition：
帳票を絞り込んで検索するときの条件を指定します。
の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
resultLimit：
帳票の最大取得件数を指定します。
「0」以下の値を指定した場合は無制限となります。
戻り値
一覧で取得した結果
例外
Operate Exception：
取得処理でエラーが発生した場合
- 115 -
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public Form[]
getForms(java.lang.String logicalDestination,FormFilterCondition condition,SortOrder[] sortOrder)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
検索対象にする論理あて先名、および帳票の絞り込み条件を指定して、帳票を取得します。
パラメータ
logicalDestination：
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
すべての論理あて先を検索対象にする場合は、「null」を指定します。
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
帳票の一覧
例外
Operate Exception：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
- 116 -
・同じソート項目を複数指定した場合
・ソート項目を6 個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/ 検索し
た論理あて先名）が更新される場合があります。
詳細については、以下を参照してください。
⇒“3.6.3 LMUserInfoクラス”のgetLastViewLD()”
public ListResult
getForms(java.lang.String logicalDestination,FormFilterCondition condition,SortOrder[] sortOrder,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
検索対象にする論理あて先名、帳票の絞り込み条件、および最大取得件数を指定して、帳票を取得します。
最大取得件数は、取得する帳票の最大数です。
取得した帳票は、ListResultクラスのgetListメソッドで取得します。getListメソッドの戻り値を、帳票の配列Form[]にキャストして取得しま
す。
パラメータ
logicalDestination：
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
すべての論理あて先を検索対象にする場合は、「null」を指定します。
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先
度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内
で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
resultLimit：
帳票の最大取得件数を指定します。
「0」以下の値を指定した場合は無制限となります。
- 117 -
戻り値
一覧で取得した結果
例外
Operate Exception：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
・このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/ 検索し
た論理あて先名）が更新される場合があります。
詳細については、以下を参照してください。
⇒“3.6.3 LMUserInfoクラス”のgetLastViewLD()”
public ListResult
getForms(FormFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して、部分的な帳票の一覧を取得します。
最大取得件数は取得する帳票の最大数です。
帳票を取得した結果は、ListResult クラスのgetList メソッドの戻り値をForm[] にキャストして取得します。
パラメータ
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目名は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優
先度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定
したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
- 118 -
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
startPosition：
部分取得する際の取得開始位置を指定します。
「0」以下を指定した場合は先頭から取得します（「1」を指定した場合と同じです）。
帳票一覧取得時に指定する絞り込み条件（condition）に一致する帳票の件数より大きい値を指定した場合は取得件数が0件にな
ります。
resultLimit：
最大取得件数を指定します。
「0」以下を指定した場合は無制限に取得します。
帳票一覧取得時に指定する絞り込み条件（condition）に一致する帳票の件数より大きい値を指定した場合は、絞り込み条件に一
致する件数分だけ取得し、例外は発生しません。
戻り値
一覧で取得した結果
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public ListResult
getForms(java.lang.String logicalDestination,FormFilterCondition condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
throws OperateException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
論理あて先、帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して帳票を取得します。
最大取得件数は取得する帳票の最大数です。
帳票を取得した結果は、ListResult クラスのgetList メソッドの戻り値をForm[] にキャストして取得します。
パラメータ
logicalDestination：
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
「null」を指定した場合はすべての論理あて先を検索対象にします。
- 119 -
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
sortOrder：
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目名は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優
先度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定
したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
startPosition：
部分取得する際の取得開始位置を指定します。
「0」以下を指定した場合は先頭から取得します（「1」を指定した場合と同じです）。
帳票一覧取得時に指定する絞り込み条件（logicalDestination, condition）に一致する帳票の件数より大きい値を指定した場合は取
得件数が0件になります。
resultLimit：
最大取得件数を指定します。
「0」以下を指定した場合は無制限に取得します。
帳票一覧取得時に指定する絞り込み条件（logicalDestination, condition）に一致する帳票の件数より大きい値を指定した場合は、
絞り込み条件に一致する件数分だけ取得し、例外は発生しません。
戻り値
一覧で取得した結果
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・指定できないソート項目がある場合
・同じソート項目を複数指定した場合
・ソート項目を6個以上指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
・このメソッドで帳票を取得すると、LMUserInfo クラスのgetLastViewLD メソッドで取得できる値（ユーザが最後に帳票を取得/ 検索
した論理あて先名）が更新される場合があります。
- 120 -
詳細については、以下を参照してください。
⇒“3.6.3 LMUserInfoクラス”のgetLastViewLD()”
public int
getFormsCount(java.lang.String logicalDestination, FormFilterCondition condition)
throws OperateException, java.lang.IllegalStateException
用途
論理あて先、帳票の絞り込み条件を指定して、指定した条件に一致する帳票の総件数を取得します。
パラメータ
logicalDestination：
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
「null」を指定した場合はすべての論理あて先を検索対象にします。
condition：
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
戻り値
指定した条件に一致する帳票の総件数
例外
OperateException：
取得処理でエラーが発生した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
public void
update(java.lang.String formID, LMParametersList updateItems)
throws OperateException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
List Manager 管理データベースに管理されている帳票のカスタマイズ項目、業務あて先を更新します。
パラメータ
formID：
更新対象とする帳票の帳票IDを指定します。
- 121 -
updateItems：
更新対象とするカスタマイズ項目、業務あて先を、LMParameterKeyクラスの以下のフィールドを使用して、Stringオブジェクトで指
定することができます。
updateItemsパラメータを使用して更新対象として指定できる帳票属性
指定できるキーのフィールド名
更新対象の帳票属性
PARAM_FORM_CUSTOMIZEITEM1
カスタマイズ項目1
PARAM_FORM_CUSTOMIZEITEM2
カスタマイズ項目2
PARAM_FORM_CUSTOMIZEITEM3
カスタマイズ項目3
PARAM_FORM_CUSTOMIZEITEM4
カスタマイズ項目4
PARAM_FORM_CUSTOMIZEITEM5
カスタマイズ項目5
PARAM_FORM_CUSTOMIZEITEM6
カスタマイズ項目6
PARAM_FORM_CUSTOMIZEITEM7
カスタマイズ項目7
PARAM_FORM_CUSTOMIZEITEM8
カスタマイズ項目8
PARAM_FORM_CUSTOMIZEITEM9
カスタマイズ項目9
PARAM_FORM_CUSTOMIZEITEM10
カスタマイズ項目10
PARAM_FORM_CUSTOMIZEITEM11
カスタマイズ項目11
PARAM_FORM_CUSTOMIZEITEM12
カスタマイズ項目12
PARAM_FORM_CUSTOMIZEITEM13
カスタマイズ項目13
PARAM_FORM_OPERATORID_INFO
業務あて先
例外
OperateException：
更新処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・帳票IDの値として、「null」が指定された場合
・ updateItemsパラメータとして、「null」が指定された場合
・カスタマイズ項目、業務あて先の値として、Stringオブジェクト以外が指定された場合
・ updateItemsパラメータの各キーに「null」が指定された場合
・ updateItemsパラメータのキーとしてカスタマイズ項目、業務あて先のいずれも指定しなかった場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・業務あて先の指定方法は、帳票登録時に指定した形式と同じ形式で指定してください。
・更新する値を何も指定せずに更新した場合、更新後に帳票情報を再度取得し、更新した項目をFormクラスから取り出すと「null」
を取得します。
備考
・更新する値を空にしたい場合は値を何も指定せずに更新します。
・ updateItemsパラメータに指定されたキー以外の項目は更新されません。
- 122 -
・帳票属性を更新するには、更新対象の帳票が存在する論理あて先に対して操作権限が必要です。ただし、論理あて先の権限が
ない場合でも、更新対象とする帳票の作成ユーザであれば更新できます。
・更新処理が正常終了した場合でも取得済みのFormオブジェクトのカスタマイズ項目、業務あて先は更新されません。再度、取得
してください。
・カスタマイズ項目、業務あて先に指定できるデータ長は以下のとおりです。
更新対象の帳票属性に指定できるデータ長
更新対象の帳票属性
データ長（単位：バイト）
カスタマイズ項目1
8
カスタマイズ項目2
8
カスタマイズ項目3
8
カスタマイズ項目4
1024
カスタマイズ項目5
1024
カスタマイズ項目6
256
カスタマイズ項目7
256
カスタマイズ項目8
256
カスタマイズ項目9
256
カスタマイズ項目10
64
カスタマイズ項目11
64
カスタマイズ項目12
64
カスタマイズ項目13
64
業務あて先
256
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
ユーザアプリケーション種別は、ホスト帳票連携機能を利用する
ユーザアプリケーションです。
- 123 -
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()
帳票の配信通番を取得します。
java.lang.String
getConnectorSequenceNo()
帳票のコネクタ通番を取得します。
java.lang.String
getConnectorSequenceNo2()
帳票のコネクタ通番2を取得します。
- 124 -
メソッドの概要
java.lang.String
getConnectorSequenceNo3()
帳票のコネクタ通番3を取得します。
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()
帳票の出力状態を取得します。
- 125 -
メソッドの概要
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を取得します。
- 126 -
メソッドの概要
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)
帳票を複写します。
- 127 -
メソッドの概要
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()
- 128 -
用途
帳票の帳票IDを取得します。
帳票IDは、List Managerで、帳票を一意に識別するために割り当てられるIDです。
戻り値
帳票ID
public java.lang.String
getDeliverySequenceNo()
用途
帳票の配信通番を取得します。
配信通番は、List Managerで帳票出力サーバに配信された時点で採番されます。
戻り値
配信通番
なお、配信通番が採番されていない場合は「null」が取得されます。
public java.lang.String
getConnectorSequenceNo()
用途
帳票のコネクタ通番を取得します。
コネクタ通番は、GSコネクタ連携機能を使用する場合の以下の通番に相当します。
・配信通番をもとにしたコネクタ通番（APS連携時）
・メッセージ送出サービスの論理あて先通番（MSSP連携時）
戻り値
コネクタ通番
なお、コネクタ通番が採番されていない場合は「null」が取得されます。
public java.lang.String
getConnectorSequenceNo2()
用途
帳票のコネクタ通番2を取得します。
コネクタ通番2は、GSコネクタ連携機能を使用する場合の、作成通番をもとにしたコネクタ通番（APS連携時）に相当します。
戻り値
コネクタ通番2
なお、コネクタ通番2が採番されていない場合は「null」が取得されます。
- 129 -
public java.lang.String
getConnectorSequenceNo3()
用途
帳票のコネクタ通番3を取得します。
コネクタ通番3は、GSコネクタ連携機能を使用する場合の、再送通番をもとにしたコネクタ通番（APS連携時）に相当します。
戻り値
コネクタ通番3
なお、コネクタ通番3が採番されていない場合は「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
- 130 -
getCreateUser()
用途
帳票の作成ユーザを取得します。
戻り値
作成ユーザ
public java.util.Date
getCreateDatetime()
用途
帳票の作成日時を取得します。
戻り値
作成日時
public boolean
isFinished()
用途
帳票の出力が完了したかどうかを取得します。
戻り値
true：
出力が完了した場合
false：
出力が完了していない場合、または論理あて先の論理あて先タイプがWeb手元印刷用の場合
public int
getTotalPage()
用途
出力ページ数を取得します。
出力ページ数とは、実際に出力する帳票のページ数です。
帳票出力時に、出力するページの範囲を指定した場合、指定した範囲内のページ数が取得されます。
戻り値
出力ページ数
ページ数がカウントされない場合は「0」が取得されます。
備考
・ページ数のカウント方法については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“C.3 帳票のページ数のカウント
方法”を参照してください。
- 131 -
public int
getPrintedPage()
用途
出力完了ページ数を取得します。
出力完了ページ数は、実際に出力が完了したページ数です。
戻り値
出力完了ページ数
ページ数がカウントされない場合は「0」が取得されます。
備考
・ページ数のカウント方法については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“C.3 帳票のページ数のカウント
方法”を参照してください。
public int
getFormTotalPage()
用途
帳票の総ページ数を取得します。
帳票の総ページ数は、帳票全体のページ数です。
戻り値
帳票の総ページ数
ページ数がカウントされない場合は「0」が取得されます。
備考
・ページ数のカウント方法については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“C.3 帳票のページ数のカウント
方法”を参照してください。
public java.lang.String
getName()
用途
帳票名を取得します。
戻り値
帳票名
public java.lang.String
getTitle()
- 132 -
用途
帳票のタイトルを取得します。
戻り値
タイトル
public java.lang.String
getComment()
用途
帳票のコメントを取得します。
戻り値
コメント
なお、コメントが指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public boolean
isOutputForm()
用途
帳票作成後の出力指定を取得します。
帳票作成後の出力指定は、帳票作成後に続けて出力を行うかどうかの指定です。
戻り値
true：
帳票作成後に続けて出力する場合
false：
帳票作成後に続けて出力しない場合
public boolean
isKeepForm()
用途
帳票出力後の保存指定を取得します。
帳票出力後の保存指定は、帳票出力後にList Managerで帳票を保存するかどうかの指定です。
戻り値
true：
帳票出力後に帳票を保存する場合
false：
帳票出力後に帳票を保存しない場合
public java.util.Date
- 133 -
getSaveLimitDate()
用途
帳票の保存期限を取得します。
保存期限は、帳票を保存する期間の終点の日付を示します。
保存期限の詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“6.2.4.3 lmdelexpireコマンド”の“［補足］”を
参照してください。
戻り値
保存期限（帳票を保存する期間の終点の日付）
なお、保存期限が指定されていない場合は「null」が取得されます。この「null」は、帳票が無期限に保存されることを示します。
public int
getCopy()
用途
帳票の出力時の印刷部数を取得します。
戻り値
印刷部数
public java.lang.String
getPaperCode()
用途
帳票の用紙コードを取得します。
ここで取得される用紙名は、帳票属性の編集コマンド（lmedtformatrコマンド）で指定した用紙コードです。COBOLアプリケーション連
携機能の印刷属性ファイルで指定した用紙名は取得されません。
戻り値
用紙コード
public int
getOutputStatus()
用途
帳票の出力状態を取得します。
戻り値
出力状態を示すフィールドの中の1つ
フィールドの詳細については、以下を参照してください。
⇒“FormクラスのgetOutputStatusメソッドで取得されるフィールド”
public java.lang.String
- 134 -
getOperatorIdInfo()
用途
帳票の業務あて先を取得します。
戻り値
業務あて先
なお、業務あて先が設定されていない場合は、「null」が取得されます。
public java.lang.String
getPrintoutUserID()
用途
最終出力者IDを取得します。
戻り値
最終出力者ID
なお、最終出力者IDが設定されていない場合は、「null」が取得されます。
備考
・最終出力者IDは、以下の場合に自動更新されます。
－操作画面の帳票一覧画面、帳票ブラウザから出力を行った場合
－運用コマンドから出力を行った場合
－帳票を出力するユーザアプリケーションを使用して出力を行った場合
－帳票管理Javaインタフェースの以下の帳票出力をともなうメソッド、またはFormクラスのcreateOutputData メソッドを指定した場
合
- Formクラスのprintoutメソッドを指定した場合で、帳票の出力状態が「出力保留」以外のとき
- Formクラスのcopyメソッドまたはmoveメソッドにおいて、isOutputパラメータに「true」を指定した場合
- LogicalDestinationクラスのcopyAllFormsメソッドにおいて、isOutputパラメータに「true」を指定した場合
public java.util.Date
getPrintoutDatetime()
用途
帳票の出力依頼日時を取得します。
戻り値
出力依頼日時
なお、出力依頼日時が設定されていない場合は、「null」が取得されます。
備考
・出力依頼日時は、以下の場合に自動更新されます。
－操作画面の帳票一覧画面、帳票ブラウザから出力を行った場合
- 135 -
－運用コマンドから出力を行った場合
－帳票を出力するユーザアプリケーションを使用して出力を行った場合
－帳票管理Javaインタフェースの以下の帳票出力をともなうメソッド、またはFormクラスのcreateOutputData メソッドを指定した場
合
- Formクラスのprintoutメソッドを指定した場合で、帳票の出力状態が「出力保留」以外のとき
- Formクラスのcopyメソッドまたはmoveメソッドにおいて、isOutputパラメータに「true」を指定した場合
- LogicalDestinationクラスのcopyAllFormsメソッドにおいて、isOutputパラメータに「true」を指定した場合
public int
getPrintoutCount()
用途
帳票の出力回数を取得します。
戻り値
出力回数
備考
・帳票の出力回数は、以下の場合に自動更新されます。
－操作画面の帳票一覧画面、帳票ブラウザから出力を行った場合
－運用コマンドから出力を行った場合
－帳票を出力するユーザアプリケーションを使用して出力を行った場合
－帳票管理Javaインタフェースの以下の帳票出力をともなうメソッド、またはFormクラスのcreateOutputDataメソッドを指定した場合
- Formクラスのprintoutメソッドを指定した場合で、帳票の出力状態が「出力保留」以外のとき
- Formクラスのcopyメソッドまたはmoveメソッドにおいて、isOutputパラメータに「true」を指定した場合
- LogicalDestinationクラスのcopyAllFormsメソッドにおいて、isOutputパラメータに「true」を指定した場合
public int
getPreviewCount()
用途
帳票のプレビュー回数を取得します。
戻り値
プレビュー回数
備考
・帳票のプレビュー回数は、以下の場合に自動更新されます。
－操作画面の帳票一覧や帳票ブラウザからプレビューを行った場合
－帳票管理Javaインタフェースのプレビューメソッドを指定した場合
public java.lang.String
- 136 -
getErrorSender()
用途
帳票のエラーメッセージの送信元を取得します。
エラーメッセージの送信元は、出力状態が「失敗」の場合に、エラーが発生したコンピュータの名前が設定されます。
出力状態が「失敗」以外の場合に設定される値は不定です。
戻り値
エラーメッセージの送信元
エラーが発生した帳票管理サーバ名、または帳票出力サーバ名が設定されます。
なお、エラーメッセージの送信元が指定されていない場合、または半角空白だけの場合は「null」が取得されます。
public int
getErrorNo()
用途
帳票のエラーメッセージ番号を取得します。
エラーメッセージ番号は、出力状態が「失敗」の場合に、エラー発生機能IDが設定されます。
出力状態が「失敗」以外の場合に設定される値は不定です。
戻り値
エラーメッセージ番号（エラー発生機能名）
エラーメッセージ番号
エラー発生機能名
0x00000001
帳票管理サーバ
0x00000002
帳票出力サーバ
0x00000003
印刷実行アプリケーション（COBOLアプリケーション連携機
能を利用するユーザアプリケーション）
0x00000004
印刷実行アプリケーション（List Manager帳票出力インタ
フェースを利用するユーザアプリケーション）
0x00000005
印刷実行アプリケーション（ホスト帳票連携機能を利用する
ユーザアプリケーション）
public int
getErrorDetailCode()
用途
帳票のエラー詳細コードを取得します。
エラー詳細コードは、出力状態が「失敗」、「出力エラー」、または「応答待ち」の場合に設定されます。出力状態が「失敗」の場合は、
エラー発生原因コードが設定されます。出力状態が「出力エラー」または「応答待ち」の場合は、プリンタのエラー詳細コードが設定さ
れます。
出力状態が「失敗」、「出力エラー」、および「応答待ち」以外の場合に設定される値は不定です。
- 137 -
戻り値
エラー詳細コード
エラー詳細コードについてはgetErrorDetailMessageメソッドの出力状態、エラー詳細コード、エラー詳細メッセージ表を参照してくださ
い。
public java.lang.String
getErrorDetailMessage()
throws MissingResourceException
用途
帳票のエラー詳細メッセージを取得します。
出力状態が「失敗」、「出力エラー」、または「応答待ち」の場合にエラー詳細メッセージを取得します。
戻り値
エラー詳細メッセージ
出力状態が「失敗」、「出力エラー」、または「応答待ち」以外の場合は、「null」が取得されます。
以下に出力状態、エラー詳細コードとエラー詳細メッセージの対応を示します。
出力状態
エラー詳細コード
エラー詳細メッセージ
出力エラー
0x00000001
プリンタ装置で異常が発生しました。プリンタ装置を確
認してください。
出力エラー
0x00000002
プリンタ装置で異常が発生しました。プリンタ装置を確
認してください。
出力エラー
0x00000004
プリンタ装置で異常が発生しました。プリンタ装置を確
認してください。
出力エラー
0x00000008
プリンタ装置で用紙詰まりが発生したため印刷できませ
ん。詰まった用紙を取り除いてください。
出力エラー
0x00000010
プリンタ装置で用紙切れのため印刷できません。用紙を
補給してください。
出力エラー
0x00000020
プリンタ装置で手差しトレイへの用紙補給待ちです。手
差しトレイに用紙を補給してください。
出力エラー
0x00000040
プリンタ装置で用紙エラーが発生しました。プリンタ装置
を確認してください。
出力エラー
0x00000080
プリンタ装置がオフライン状態のため印刷できません。
オンライン状態にしてください。
出力エラー
0x00000800
プリンタ装置で排出トレイが一杯になったため印刷でき
ません。排出トレイの用紙を取り除いてください。
出力エラー
0x00020000
プリンタ装置でトナーの残量が少なくなったため印刷で
きません。トナーを交換してください。
出力エラー
0x00040000
プリンタ装置でトナーがなくなったため印刷できません。
トナーを交換してください。
出力エラー
0x00100000
プリンタ装置でユーザ操作が必要な状態です。プリンタ
装置を確認してください。
出力エラー
0x00200000
プリンタ装置でメモリ不足のため印刷できません。プリン
タ装置を確認してください。
- 138 -
出力状態
エラー詳細コード
エラー詳細メッセージ
出力エラー
0x00400000
プリンタ装置でカバーが開いているため印刷できませ
ん。カバーを閉じてください。
出力エラー
0x10000000
プリンタ装置で異常が発生しました。プリンタ装置を確
認してください。
出力エラー
0x40000000
プリンタ装置でハード異常が発生しました。プリンタ装置
を確認してください。
出力エラー
0x80000000
プリンタ装置と通信できません。プリンタ装置、または接
続環境を確認してください。
応答待ち
0x20000000
ユーザ応答待ちです。ユーザ応答待ちに応答してくだ
さい。
失敗
0x00020000
メモリが不足しています。不要なアプリケーションを終了
し、再度、失敗した操作を実行してください。
失敗
0x00030000
ディスクが不足しています。ディスクの空き容量を確認
し、不要なファイルを削除して、再度、失敗した操作を
実行してください。
失敗
0x00040000
リソースが不足しています。不要なアプリケーションを終
了する、仮想メモリを増やす、またはメモリを増設し、再
度、失敗した操作を実行してください。
失敗
0x00050000
ファイル、またはディレクトリへのアクセスに失敗しまし
た。異常となったファイル、またはディレクトリの権限を見
直し、再度、失敗した操作を実行してください。
失敗
0x00060000
必要な帳票資源が配置されていません。帳票資源の配
置ディレクトリの指定に誤りがないか、または、帳票資源
が正しく配置されているかを確認し、再度、アプリケー
ションを実行してください。
失敗
0x00060201
帳票定義情報が見つかりません。帳票定義情報の指定
を確認し、再度、アプリケーションを実行してください。
失敗
0x00060202
配置されている資源に異常があります。帳票資源が壊
れていないか確認してください。
失敗
0x00060203
配置されている資源に異常があります。帳票資源が壊
れていないか確認してください。
失敗
0x00060301
オーバレイファイルが見つかりません。オーバレイファイ
ルの指定を確認し、再度、アプリケーションを実行してく
ださい。
失敗
0x00060401
メディアデータファイルが見つかりません。メディアデー
タファイルの指定を確認し、再度、アプリケーションを実
行してください。
失敗
0x00060501
プリンタ情報ファイルが見つかりません。プリンタ情報ファ
イルの指定を確認し、再度、アプリケーションを実行して
ください。
失敗
0x00060502
プリンタ情報ファイルの内容に誤りがあります。プリンタ
情報ファイルの内容を見直し、再度、アプリケーションを
実行してください。
失敗
0x00060601
帳票出力に使用する初期化ファイル、または情報ファイ
ルが見つかりません。帳票出力に使用する初期化ファ
イル、または情報ファイルの指定を確認し、再度、アプリ
ケーションを実行してください。
- 139 -
出力状態
エラー詳細コード
エラー詳細メッセージ
失敗
0x00060a01
PDFメール配信に使用するファイルが見つかりません。
PDFメール配信に使用するファイルの指定を確認し、再
度、アプリケーションを実行してください。
失敗
0x00060b01
必要な帳票資源が配置されていません。帳票資源の配
置ディレクトリの指定に誤りがないか、または、帳票資源
が正しく配置されているかを確認し、再度、アプリケー
ションを実行してください。
失敗
0x00060c01
FAX受信者情報ファイルが見つかりません。FAX受信
者情報ファイルの指定を確認し、再度、アプリケーション
を実行してください。
失敗
0x00060d01
PDFに添付するファイルが見つかりません。PDFに添付
するファイルの指定を確認し、再度、アプリケーションを
実行してください。
失敗
0x00060e01
帳票の入力データファイルが見つかりません。帳票の入
力データファイルを確認し、再度、アプリケーションを実
行してください。
失敗
0x00060f01
アプリケーションで指定した転送ファイルが見つかりませ
ん。転送ファイルの指定を確認し、再度、アプリケーショ
ンを実行してください。
失敗
0x00061001
アプリケーションで指定したバイナリ転送ファイルが見つ
かりません。バイナリ転送ファイルの指定を確認し、再
度、アプリケーションを実行してください。
失敗
0x00061101
初期化ファイル、または情報ファイル中に、必要なセク
ションが見つかりません。必要なセクションを指定後、再
度、アプリケーションを実行してください。
失敗
0x00061201
FAX配信情報に誤りがあります。帳票管理サーバでFAX
配信属性ファイルを指定していることと、FAX配信属性
ファイルの受信者の指定が正しいことを確認し、再度、
アプリケーションを実行してください。
失敗
0x00061301
指定されたフォントファイルのアクセスに失敗しました。
指定したフォントファイルが存在するか、またはアクセス
権があるか確認してください。
失敗
0x00061302
指定されたフォントファイルが壊れている可能性がありま
す。指定したフォントファイルがTrueType フォントファイ
ルか確認してください。
失敗
0x00061303
指定された外字フォントファイルのアクセスに失敗しまし
た。指定した外字フォントファイルが存在するか、また
は、アクセス権があるかを確認してください。
失敗
0x00061304
指定されたフォント番号のフォントが、フォントファイルに
見つかりません。指定したフォント番号を確認してくださ
い。
失敗
0x00061401
帳票データファイル格納ディレクトリ配下のアクセス権を
確認してください。List Managerを移行した場合は、帳
票データファイルが確実に移行されたことを確認してく
ださい。
失敗
0x00070000
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
- 140 -
出力状態
エラー詳細コード
エラー詳細メッセージ
失敗
0x00070001
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070002
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070003
ファイル、またはディレクトリへのアクセスに失敗しまし
た。異常となったファイル、またはディレクトリの権限を見
直し、再度、失敗した操作を実行してください。
失敗
0x00070004
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070103
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x00070201
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070202
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070301
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070401
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070402
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00070501
環境変数の指定に誤りがあります。環境変数を確認し、
再度、アプリケーションを実行してください。
失敗
0x00070601
ファイル、またはディレクトリが存在しません。異常となっ
たファイル、またはディレクトリが存在するか確認し、再
度、失敗した操作を実行してください。
失敗
0x00070801
システム時間が異常です。システムの時間設定、または
帳票定義情報の更新日時を確認してください。
失敗
0x00070901
帳票の出力処理でタイムアウトが発生しました。帳票出
力サーバのサービス（「PRT Server Service」「WORKIT
MSG(F3BW)」）が起動されているか確認し、再度、帳票
を出力してください。
失敗
0x00071001
ファイルをオープンできる上限を超えている可能性があ
ります。システム環境を見直してください。
失敗
0x00071101
ファイル、またはディレクトリが作成できません。ファイ
ル、またはディレクトリのフルパスがOSのパスの最大長
より短くなるように変更してください。
失敗
0x00072001
帳票登録後に続けて、帳票を出力することができません
でした。指定された帳票登録後の出力指定、または、帳
票属性の出力処理モードに設定した値に誤りがないか
確認してください。
- 141 -
出力状態
エラー詳細コード
エラー詳細メッセージ
失敗
0x00072002
出力ファイルを作成できませんでした。出力方法に設定
した値に誤りがないか確認してください。
失敗
0x00073001
必要なライブラリが見つかりませんでした。ライブラリを配
置したか、パスが通っているか確認してください。
失敗
0x00073002
ライブラリが正しくありません。指定したライブラリが正し
いか、およびライブラリの動作環境を確認してください。
失敗
0x0007ffff
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x00080000
帳票出力サーバへの通信に失敗しました。帳票出力
サーバが動作していない、または高負荷状態でないか
確認してください。
失敗
0x00080001
帳票出力サーバへの通信に失敗しました。帳票出力
サーバが動作していない、または高負荷状態でないか
確認してください。
失敗
0x00080002
帳票出力サーバへの通信に失敗しました。ネットワーク
環境、および帳票出力サーバの動作を確認し、再度、
失敗した操作を実行してください。
失敗
0x00080003
帳票出力サーバへの通信に失敗しました。ネットワーク
環境、および帳票出力サーバの動作を確認し、再度、
失敗した操作を実行してください。
失敗
0x00080004
帳票出力サーバへの通信に失敗しました。ホスト名を解
決するための設定を確認し、再度、失敗した操作を実
行してください。
失敗
0x00080005
帳票出力サーバへの通信に失敗しました。ネットワーク
環境、および帳票出力サーバの動作を確認し、再度、
失敗した操作を実行してください。
失敗
0x00080006
IPアドレス、またはポート番号が利用できません。環境
設定のIPアドレス(TcpBindAddress)、またはポート番号
(TcpSvrPortNum)を確認してください。
失敗
0x00090101
COBOLアプリケーションが出力するデータが異常です。
COBOLアプリケーションが出力するデータを見直し、再
度、帳票を出力してください。
失敗
0x000a0000
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000a0001
データベースに接続できませんでした。データベースが
起動しているか、または環境設定が正しいかどうかを確
認してください。
失敗
0x000a0002
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000a0003
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000a0004
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000a0005
高負荷のためデータベースのアクセスで資源不足が発
生しました。再度、失敗した操作を実行してください。
- 142 -
出力状態
エラー詳細コード
エラー詳細メッセージ
失敗
0x000a0006
データベースの最大同時接続数に達していたため接続
できませんでした。データベースの環境を見直してくだ
さい。
失敗
0x000a0007
データベースのアクセスでエラーが発生しました。デー
タベースの動作、および環境を見直してください。
失敗
0x000a0008
データベースのアクセスでエラーが発生しました。デー
タベースの動作、および環境を見直してください。
失敗
0x000a0009
データベースのアクセスでエラーが発生しました。デー
タベースの動作、および環境を見直してください。
失敗
0x000a000b
複写可能な最大数を超えました。複写元の帳票を確認
して登録し直してください。
失敗
0x000a000c
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000a0010
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000a0099
データベースのアクセスでエラーが発生しました。デー
タベースの環境を見直してください。
失敗
0x000c0404
動作環境が異常です。システム環境、製品のインストー
ル状態、および帳票管理サーバの環境設定ファイルの
内容を見直し、再度、実行してください。
失敗
0x000c0501
ページ指定エラーです。指定したページ数が帳票の
ページ数の範囲内であるか、またはページ指定可能な
帳票であるか確認してください。
失敗
0x000c0504
出力先のプリンタへアクセスできませんでした。プリンタ
が定義されているか、または、プリンタに対して出力する
権限があるか確認してください。
失敗
0x000c0601
論理あて先に登録されている論理デバイスの出力方法
が異常です。論理あて先に登録されている論理デバイ
スを、他の出力方法が設定されている論理デバイスに
切り替えてください。
失敗
0x000e0400
帳票出力で異常が発生しました。帳票出力サーバの動
作を確認し、再度、失敗した操作を実行してください。
失敗
0x000e0410
ログオンできませんでした。Windowsにユーザが登録さ
れていること、およびユーザの権限を確認してください。
失敗
0x000d0000
文字コード変換で異常が発生しました。文字コードに関
する設定を確認し、再度、アプリケーションを実行して下
さい。
失敗
0xfffe0001
ファイル、またはディレクトリが存在しません。異常となっ
たファイル、またはディレクトリが存在するか確認し、再
度、失敗した操作を実行してください。
失敗
0xfffe0002
メモリが不足しています。不要なアプリケーションを終了
し、再度、失敗した操作を実行してください。
失敗
0xfffe0003
ファイル、またはディレクトリへのアクセスに失敗しまし
た。異常となったファイル、またはディレクトリの権限を見
直し、再度、失敗した操作を実行してください。
失敗
0xfffe0004
ファイル、またはディレクトリのパスが存在しません。異常
となったファイル、またはディレクトリのパスが存在するか
確認し、再度、失敗した操作を実行してください。
- 143 -
出力状態
エラー詳細コード
エラー詳細メッセージ
失敗
0xfffe0005
パスが長すぎる、もしくは無効な名前が指定されました。
異常となったパスを見直して、再度、失敗した操作を実
行してください。
失敗
0xfffe0007
リソースが不足しています。不要なアプリケーションを終
了する、仮想メモリを増やす、またはメモリを増設し、再
度、失敗した操作を実行してください。
失敗
0xfffe0008
ディスクが不足しています。ディスクの空き容量を確認
し、不要なファイルを削除して、再度、失敗した操作を
実行してください。
失敗
0xffff1000
帳票出力で異常が発生しました。詳細はMeFtのイベン
トログを参照してエラー原因を取り除き、再度、帳票を出
力してください。
失敗
0xffff2000
帳票出力で異常が発生しました。詳細はFJSVoastのシ
ステムログを参照してエラー原因を取り除き、再度、帳
票を出力してください。
失敗
0xffff3000
帳票出力で異常が発生しました。帳票出力サーバの動
作を確認し、再度、失敗した操作を実行してください。
失敗
0xffff4000
帳票出力で異常が発生しました。帳票出力サーバの動
作を確認し、再度、失敗した操作を実行してください。
出力エラー
応答待ち
失敗
上記以外
異常が発生しました。繰り返し発生する場合には、障害
調査用情報採取ツールを使用して調査資料を採取し、
当社技術員に連絡してください。
例外
MissingResource Exception：
動作環境が異常な状態で実行した場合
public java.lang.String
getExtension()
用途
帳票を出力したアプリケーションに対応しているファイルの拡張子を取得します。
取得した拡張子は、プレビュー用データをファイルにする場合に、ファイル名の拡張子として使用します。
戻り値
ファイルの拡張子（「owf」または「pdf」）
取得されるファイルの拡張子は、ユーザアプリケーション種別によって、以下のように異なります。
ユーザアプリケーション種別
COBOLアプリケーション連携機能を利用するユーザアプリ
ケーション
取得されるファイルの拡張子
owf
List Manager帳票出力インタフェースを利用するユーザアプ
リケーション
ホスト帳票連携機能を利用するユーザアプリケーション
pdf
- 144 -
public java.lang.String
getMimeType()
用途
帳票を出力したユーザアプリケーションに対応しているMIMEタイプを取得します。
取得したMIMEタイプは、プレビュー用データをWebブラウザに表示する場合に使用します。
戻り値
MIMEタイプ（「application/x-owf」または「application/pdf」）
取得されるMIMEタイプは、ユーザアプリケーション種別によって、以下のように異なります。
ユーザアプリケーション種別
COBOLアプリケーション連携機能を利用するユーザアプリ
ケーション
取得されるMIMEタイプ
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を取得します。
- 145 -
戻り値
カスタマイズ項目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の値
- 146 -
なお、カスタマイズ項目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
- 147 -
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桁）の範囲で指定します。
- 148 -
－ startPageパラメータで開始ページを指定した場合、その開始ページ以降のページ番号を指定します。
－「0」を指定した場合、最終ページが指定されたとみなされます。ただし、帳票登録時にページ範囲を指定した場合、ユーザア
プリケーションで指定した終了ページが有効になります。
COBOLアプリケーション連携機能を利用して帳票を出力する場合、指定可能なページ数は、1～99999（最大5桁）の範囲です。
帳票の総ページ数が100000ページ以上の場合は、以下の点に注意してください。
－ startPageパラメータに1～99999の範囲の値を指定し、endPageパラメータに「0」を指定した場合、指定した開始ページから99999
ページ目まで出力されます。
－ 100000ページ目以降のページを出力したい場合、startPageパラメータおよびendPageパラメータに「0」を指定し、すべてのペー
ジを出力する必要があります。
copy：
印刷部数を 1～999 の範囲で指定します。
「0」を指定した場合、「1」が指定されたとみなされます。
例外
OperateForm Exception：
・出力処理でエラーが発生した場合
・ List Managerが開始されていない状態の場合
・帳票の出力状態が「出力保留」の場合、開始ページ、終了ページに、帳票の総ページ数より大きな値を指定した場合
java.lang.Illegal ArgumentException：
・開始ページ、終了ページに、0～99999999以外の値を指定した場合
・開始ページに、終了ページの値より大きい値を指定した場合
・印刷部数に、0～999以外の値を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を出力/保留解除するには、論理あて先に対する操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
・帳票の出力状態が「出力保留」の帳票を出力するときに、Windowsのプリンタフォルダのプリンタのプロパティで、スプール形式が
「RAW」となっている場合はページを指定するとエラーになります。
・ Web手元印刷型の場合、startPageパラメータおよびendPageパラメータで指定した値は有効になりません。
・このメソッドでは、帳票登録時の印刷部数で帳票出力することはできません。帳票登録時の印刷部数で帳票出力したい場合は、
printout（int startPage, int endPage, int copy,LMParametersList printoutOptions）メソッドを使用し、copy パラメータに「0」を指定して
ください。
・出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項については、以下を参照してください。
⇒“●出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項”
備考
・ startPageパラメータ、endPageパラメータを指定した場合のページ数については、オンラインマニュアル“帳票印刷配信機能運用
ガイド”の“C.4 出力範囲を指定した場合のページ数”を参照してください。
- 149 -
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」を指定した場合は、「1」が指定されたとみなされます。ただし、帳票登録時に印刷部数を指定した場合は、ユーザアプリケーショ
ンで指定した印刷部数が有効になります。
printoutOptions：
メッセージ通知先を、LMParameterKeyクラスの以下の値で指定します。
－ PARAM_PRINTOUT_RESPONSE_MESSAGE（メッセージ通知先（返答メッセージ/応答メッセージ））
返答メッセージ/応答メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
- 150 -
－ PARAM_PRINTOUT_NOTICE_MESSAGE（メッセージ通知先（通知メッセージ））
通知メッセージの通知先として、「ホスト名」または「IP アドレス」をStringオブジェクトで指定します。
メッセージ通知先を指定しなかった場合は、帳票登録時のメッセージ通知先となります。
例外
OperateForm Exception：
・出力処理でエラーが発生した場合
・ List Manager が開始されていない状態の場合
・帳票の出力状態が「出力保留」の場合、開始ページ、終了ページに、帳票の総ページ数より大きな値を指定した場合
java.lang.Illegal ArgumentException：
・開始ページ、終了ページに、0～99999999以外の値を指定した場合
・開始ページに、終了ページの値より大きい値を指定した場合
・印刷部数に、0～999以外の値を指定した場合
・ printoutOptionsパラメータの各キーに「null」が指定された場合
・ printoutOptionsパラメータに指定できないキーを指定した場合
・ printoutOptionsパラメータに有効なキーが存在しない場合
・メッセージ通知先として、Stringオブジェクト以外が指定された場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を出力/ 保留解除するには、論理あて先に対する操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
・帳票の出力状態が「出力保留」の帳票を出力するときに、Windowsのプリンタフォルダのプリンタのプロパティで、スプール形式が
「RAW」となっている場合はページを指定するとエラーになります。
・ Web手元印刷型の場合、startPage パラメータおよびendPage パラメータで指定した値は、有効になりません。
・ printoutOptionsパラメータに「null」を指定した場合は、メッセージ通知先は帳票登録時のメッセージ通知先となります。
・出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項については、以下を参照してください。
⇒“●出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項”
・出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項ついては、以下を参照してください。
⇒“●出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項”
備考
・メッセージ通知先に、複数の通知先を指定することはできません。
・ startPageパラメータ、endPageパラメータを指定した場合のページ数については、オンラインマニュアル“帳票印刷配信機能運用
ガイド”の“C.4 出力範囲を指定した場合のページ数”を参照してください。
public void
preview(int contentType,java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
- 151 -
用途
帳票のプレビュー用データを生成します。
生成するプレビュー用データの種別を contentTypeパラメータで指定します。
パラメータ
contentType：
生成するプレビュー用データの種別を示すフィールドを指定します。
フィールドの詳細については、以下を参照してください。
⇒“Formクラスのpreviewメソッドで指定するフィールド”
out：
プレビュー用データを書き込むストリームを指定します。
例外
OperateForm Exception：
プレビュー用データの生成処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・無効な種別を指定した場合
・データを書き込むストリームが「null」の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票のプレビュー用データを生成するには、論理あて先に対する操作権限が必要です。
備考
・ contentTypeパラメータに指定できる値は、運用形態とユーザアプリケーション種別の組み合わせによって、以下のように異なりま
す。
運用形態
帳票配信型
Web手元
印刷型
出力方法が
OWFファイ
ルの場合
出力方法が
PDFファイル
の場合
ユーザアプリケーション
種別
contentTypeパラ
メータに指定できる値
プレビュー時の
ファイル形式
COBOLアプリケーション連携
機能を利用するユーザアプリ
ケーション
PREVIEW_OWF
OWFファイル
List Manager帳票出力インタ
フェースを利用するユーザア
プリケーション
PREVIEW_OWF
OWFファイル
PREVIEW_PDF
PDFファイル
ホスト帳票連携機能を利用す
るユーザアプリケーション
PREVIEW_PDF
PDFファイル
List Manager帳票出力インタ
フェースを利用するユーザア
プリケーション
PREVIEW_OWF
OWFファイル
PREVIEW_PDF
PDFファイル
- 152 -
上記以外の組み合わせでは、contentTypeパラメータは指定できません。指定した場合、例外が発生するか、または動作の保証が
できません。
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：
・無効な種別を指定した場合
・データを書き込むストリームが「null」の場合
・開始ページ、終了ページに、0～99999999以外の値を指定した場合
- 153 -
・開始ページに、終了ページの値より大きい値を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票のプレビュー用データを生成するには、論理あて先に対する操作権限が必要です。
備考
・ contentTypeパラメータに指定できる値は、運用形態とユーザアプリケーション種別の組み合わせによって、以下のように異なりま
す。
運用形態
帳票配信型
Web手元
印刷型
出力方法が
OWFファイ
ルの場合
ユーザアプリケーション
種別
contentTypeパラ
メータに指定できる値
プレビュー時の
ファイル形式
COBOLアプリケーション連携
機能を利用するユーザアプリ
ケーション
PREVIEW_OWF
OWFファイル
List Manager帳票出力インタ
フェースを利用するユーザア
プリケーション
PREVIEW_OWF
OWFファイル
PREVIEW_PDF
PDFファイル
ホスト帳票連携機能を利用す
るユーザアプリケーション
PREVIEW_PDF
PDFファイル
List Manager帳票出力インタ
フェースを利用するユーザア
プリケーション
PREVIEW_OWF
OWFファイル
PREVIEW_PDF
PDFファイル
出力方法が
PDFファイル
の場合
上記以外の組み合わせでは、contentTypeパラメータは指定できません。指定した場合、例外が発生するか、または動作の保証が
できません。
・プレビュー時のページ数と実際に出力されるページ数が異なる場合があります。詳細については、オンラインマニュアル“帳票印
刷配信機能運用ガイド”の“C.5 プレビュー時のページと実際に出力されるページ数の違い（印刷時のみ）”を参照してください。
public void
preview(java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
生成するプレビュー用データの種別を指定せず、既定形式の帳票のプレビュー用データを生成します。
パラメータ
out：
プレビュー用データを書き込むストリームを指定します。
- 154 -
例外
OperateForm Exception：
プレビュー用データの生成処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
データを書き込むストリームが「null」の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票のプレビュー用データを生成するには、論理あて先に対する操作権限が必要です。
備考
・生成されるプレビュー用データの種別は、運用形態とユーザアプリケーション種別の組み合わせによって、以下のように異なりま
す。
運用形態
帳票配信型
ユーザアプリケーション種別
COBOLアプリケーション連携機能を
利用するユーザアプリケーション
生成されるプレビュー用
データの種別
OWFファイル
List Manager帳票出力インタフェース
を利用するユーザアプリケーション
Web手元印
刷型
出力方法が
OWFファイル
の場合
ホスト帳票連携機能を利用するユー
ザアプリケーション
PDFファイル
List Manager帳票出力インタフェース
を利用するユーザアプリケーション
OWFファイル
出力方法が
PDFファイルの
場合
public void
preview(int startPage,int endPage,java.io.OutputStream out)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
生成するプレビュー用データの種別を指定せず、開始ページ、終了ページを指定して、既定形式の帳票のプレビュー用データを生
成します。
パラメータ
startPage：
プレビュー用のデータの生成を開始するページ番号を指定します。
指定方法は、以下のとおりです。
- 155 -
－プレビュー時のファイル形式が「PDFファイル」の場合
1～99999999（最大8桁）の範囲で指定します。
「0」を指定した場合、1 ページが指定されたとみなされます。
－プレビュー時のファイル形式が「OWFファイル」の場合
必ず「0」を指定してください（ページ範囲は指定できません）。
endPage：
プレビュー用のデータの生成を終了するページ番号を指定します。
指定方法は、以下のとおりです。
－プレビュー時のファイル形式が「PDFファイル」の場合
1～99999999（最大8桁）の範囲で指定します。
- startPageパラメータで開始ページを指定した場合、その開始ページ以降のページ番号を指定します。
- 「0」を指定した場合、最終ページが指定されたとみなされます。
－プレビュー時のファイル形式が「OWFファイル」の場合
必ず「0」を指定してください（ページ範囲は指定できません）。
out：
プレビュー用データを書き込むストリームを指定します。
例外
OperateForm Exception：
プレビュー用データの生成処理でエラーが発生した場合
java.lang.Illegal ArgumentException：
・データを書き込むストリームが「null」の場合
・開始ページ、終了ページに、0～99999999以外の値を指定した場合
・開始ページに、終了ページの値より大きい値を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票のプレビュー用データを生成するには、論理あて先に対する操作権限が必要です。
備考
・生成されるプレビュー用データの種別は、運用形態とユーザアプリケーション種別の組み合わせによって、以下のように異なりま
す。
運用形態
帳票配信型
ユーザアプリケーション種別
COBOLアプリケーション連携機能を
利用するユーザアプリケーション
生成されるプレビュー用
データの種別
OWFファイル
List Manager帳票出力インタフェース
を利用するユーザアプリケーション
ホスト帳票連携機能を利用するユー
ザアプリケーション
- 156 -
PDFファイル
運用形態
Web手元印
刷型
ユーザアプリケーション種別
出力方法が
OWFファイル
の場合
List Manager帳票出力インタフェース
を利用するユーザアプリケーション
生成されるプレビュー用
データの種別
OWFファイル
出力方法が
PDFファイルの
場合
・プレビュー時のページ数と実際に出力されるページ数が異なる場合があります。詳細については、オンラインマニュアル“帳票印
刷配信機能運用ガイド”の“C.5 プレビュー時のページと実際に出力されるページ数の違い（印刷時のみ）”を参照してください。
public void
preview(OutputStream out, LMParametersList outputOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
開始ページ、終了ページ、プレビュー時の印刷の抑止を指定して、帳票のプレビュー用データを生成します。
パラメータ
out：
プレビュー用データを書き込むストリームを指定します。
outputOptions：
プレビュー用データの生成のオプションを、LMParameterKeyクラスの以下のキーで指定します。「null」を指定した場合、各指定項
目の初期値が指定されたとみなされます。
－ PARAM_CONTENT_TYPE（プレビュー用データの種別）
生成するプレビュー用データの種別を指定します。指定できる値は、運用形態とユーザアプリケーション種別によって、以下の
ように異なります。
運用形態
帳票配信型
Web手元印刷
ユーザアプリケーション種別
指定できる値
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 ファイル
List Manager帳票出力インタ
フェースを利用するユーザアプリ
ケーション
OPTION_CONTENT_TYPE_
OWF
OWFファイル
OPTION_CONTENT_TYPE_
PDF
(*1)
PDFファイル
- 157 -
プレビュー時のファ
イル
形式
*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：
・プレビュー用データの生成処理でエラーが発生した場合
・プレビュー用データの種別に「OPTION_CONTENT_TYPE_PDF」を指定して、値に
「OPTION_OUTPUT_MASKED_TWICE_DISABLE」を指定した場合
java.lang.Illegal ArgumentException：
・データを書き込むストリームが「null」の場合
・ outputOptionsパラメータの各キーに「null」が指定された場合
・ outputOptionsパラメータに指定できないキーを指定した場合
・ outputOptionsパラメータに有効なキーが存在しない場合
・プレビュー用データの種別に、無効なフィールドを指定した場合
・開始ページ、終了ページに、Integerオブジェクト以外を指定した場合
・開始ページ、終了ページに、0～99999999以外の値を指定した場合
- 158 -
・開始ページに、終了ページの値より大きい値を指定した場合
・ OWFファイル時、開始ページまたは終了ページに「0」以外を指定した場合
・プレビュー時の印刷の抑止キーに、無効なフィールドを指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票のプレビュー用データを生成するには、論理あて先に対する操作権限が必要です。
備考
・プレビュー時のページ数と実際に出力されるページ数が異なる場合があります。詳細については、オンラインマニュアル“帳票印
刷配信機能運用ガイド”の“C.5 プレビュー時のページと実際に出力されるページ数の違い（印刷時のみ）”を参照してください。
public void
cancel()
throws OperateFormException,java.lang.IllegalStateException
用途
帳票の出力を中止します。
論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。
帳票の出力中止が完了すると、帳票の出力状態が「中止」に変更されます。
例外
OperateForm Exception：
・中止処理でエラーが発生した場合
・帳票出力サーバと通信できない状態で、すでに帳票出力サーバに配信済みの帳票に対して、このメソッドを指定した場合
・すでに出力済みの帳票の場合
・ List Managerが開始されていない状態の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票の出力を中止するには、論理あて先に対する操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
なお、出力を中止できる帳票が論理あて先内に存在しない場合、例外は発生しません。
備考
・帳票出力サーバの環境設定ファイルのTcpReqIntervalキーに指定した値により、帳票の出力中止が完了しても帳票の出力状態が
すぐに更新されない場合があります。
- 159 -
public void
forceCancel()
throws OperateFormException,java.lang.IllegalStateException
用途
帳票の出力を強制的に中止します。
論理あて先の論理あて先タイプが帳票配信用の場合のみ操作できます。
例外
OperateForm Exception：
・出力の強制中止処理でエラーが発生した場合
・すでに出力済みの帳票の場合
・ List Managerが開始されていない状態の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票の出力を強制的に中止するには、論理あて先に対する操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
備考
・出力の強制中止を行った場合、帳票出力サーバにおける出力状況、帳票出力サーバとの通信状態にかかわらず、List Manager
管理データベース上の帳票の出力状態を強制的に「中止」にします。そのため、帳票出力サーバに配信中、または帳票出力サー
バで出力中の帳票はそのまま処理が続行される場合があります。
public void
responseError()
throws OperateFormException,java.lang.IllegalStateException
用途
帳票の応答待ちへの応答を行います。
出力状態が「応答待ち」の帳票に対してのみ応答できます。
例外
OperateForm Exception：
・応答処理でエラーが発生した場合
・応答待ちとなっていない帳票の場合
・ List Managerが開始されていない状態の場合
- 160 -
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・応答待ちの帳票に応答するには、論理あて先に対する操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
・ List Works Workstationで、出力装置にPrint Managerで定義したプリンタを指定した場合、出力開始メッセージは到着通知パネル
で確認（応答）してください。
public void
delete()
throws OperateFormException,java.lang.IllegalStateException
用途
帳票を削除します。
例外
OperateForm Exception：
・削除処理でエラーが発生した場合
・ List Managerが開始されていない状態の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を削除するには、論理あて先に対する操作権限が必要です。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
public void
copy(java.lang.String toLogicalDestinationName,boolean isOutput)
throws OperateFormException,java.lang.IllegalArgumentException,java.lang.IllegalStateException
用途
帳票を複写します。
複写は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
パラメータ
toLogicalDestinationName：
複写先の論理あて先名を指定します。
- 161 -
論理あて先グループを複写先論理あて先にすることはできません。
isOutput：
複写後に、複写した帳票の出力を行うかどうかを指定します。
true：
複写後に帳票を出力する場合に指定します。
false：
複写後に帳票を出力しない場合に指定します。
例外
OperateForm Exception：
・複写処理でエラーが発生した場合
・複写元論理あて先または複写先論理あて先が存在しない場合
・複写元論理あて先と複写先論理あて先に同じ論理あて先を指定した場合
・複写先に、異なる論理あて先タイプの論理あて先を指定した場合
・複写先論理あて先に論理あて先グループを指定した場合
・ List Managerが開始されていない状態の場合
・ Web手元印刷型の場合で、以下の条件をすべて満たすとき
－ Web手元印刷（OWFファイル）用の論理あて先に対し、複写と同時に出力を行った（isOutputパラメータに「true」を指定した場
合）
－複写元と複写先で、帳票を出力するフォルダが同一である
－複写元の帳票が出力先のフォルダに存在する
java.lang.Illegal ArgumentException：
複写先の論理あて先名が「null」の場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を複写するには、複写元論理あて先および複写先論理あて先の両方に、論理あて先に対する操作権限が必要です。
ただし、複写元論理あて先に権限がない場合でも、帳票の作成ユーザであれば、複写できます。
備考
・複写先論理あて先に、すでに同じ帳票が存在していた場合、複写されません。
複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）、複写先論理あて先の帳票が出力されます。複写
元論理あて先の帳票は出力されません。複写元の帳票の出力状態にかかわらず、複写が正常に行われた帳票の出力状態の初
期状態は「登録」となります。
・論理あて先の論理あて先タイプがWeb手元印刷用の場合、以下のようになります。
－帳票の登録時に出力ファイル名を指定した場合、帳票の複写時には、登録時に指定した出力ファイル名が引き継がれます。
このため、複写と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）、複写元の帳票の出力ファイル名で
出力されます。
－複写元の論理あて先に対応付けされている論理デバイスの出力方法と、複写先の論理あて先に対応付けされている論理デ
バイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
- 162 -
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」が指定されたとみなされます。
- 163 -
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：
・複写処理でエラーが発生した場合
・複写元論理あて先または複写先論理あて先が存在しない場合
・複写元論理あて先と複写先論理あて先に同じ論理あて先を指定した場合
・複写先に、異なる論理あて先タイプの論理あて先を指定した場合
・複写先論理あて先に論理あて先グループを指定した場合
・ List Manager が開始されていない状態の場合
・ Web手元印刷型の場合で、以下の条件をすべて満たすとき
－ Web 手元印刷（OWF ファイル）用の論理あて先に対し、複写と同時に出力を行った（isOutput パラメータに「true」を指定した
場合）
－複写元と複写先で、帳票を出力するフォルダが同一である
－複写元の帳票が出力先のフォルダに存在する
java.lang.Illegal ArgumentException：
・複写先の論理あて先名に「null」を指定した場合
・開始ページ、終了ページ、印刷部数の値として、Integerオブジェクト以外が指定された場合
・開始ページ、終了ページに0～99999999以外の値を指定した場合
・開始ページに終了ページより大きい値を指定した場合
・印刷部数に0～999以外の値を指定した場合
・メッセージ通知先の値としてStringオブジェクト以外を指定した場合
- 164 -
・ printoutOptionsパラメータの各キーに「null」が指定された場合
・ printoutOptionsパラメータに指定できないキーを指定した場合
・ printoutOptionsパラメータに有効なキーが存在しない場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を複写するには、複写元論理あて先および複写先論理あて先の両方に、論理あて先に対する操作権限が必要です。ただ
し、複写元論理あて先に権限がない場合でも、帳票の作成ユーザであれば、複写できます。
・ printoutOptionsパラメータに「null」を指定した場合は、開始ページ、終了ページ、印刷部数に「0」が指定されたとみなされ、メッセー
ジ通知先は帳票登録時のメッセージ通知先となります。
備考
・複写先論理あて先に、すでに同じ帳票が存在していた場合、複写されません。
複写と同時に出力を行った場合（isOutputパラメータに「true」を指定した場合）、複写先論理あて先の帳票が出力されます。複写
元論理あて先の帳票は出力されません。複写元の帳票の出力状態にかかわらず、複写が正常に行われた帳票の出力状態の初
期状態は「登録」となります。
・論理あて先の論理あて先タイプがWeb手元印刷用の場合、以下のようになります。
－帳票の登録時に出力ファイル名を指定した場合、帳票の複写時には、登録時に指定した出力ファイル名が引き継がれます。
このため、複写と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）、複写元の帳票の出力ファイル名で
出力されます。
－複写元の論理あて先に対応付けされている論理デバイスの出力方法と、複写先の論理あて先に対応付けされている論理デ
バイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
・メッセージ通知先に、複数の通知先を指定することはできません。
public void
move(java.lang.String toLogicalDestinationName,boolean isOutput)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
帳票を移動します。
移動は、同じ論理あて先タイプの論理あて先に対してのみ行えます。
パラメータ
toLogicalDestinationName：
移動先の論理あて先名を指定します。
論理あて先グループを移動先論理あて先にすることはできません。
isOutput：
移動後に、移動した帳票の出力を行うかどうかを指定します。
true：
移動後に帳票を出力する場合に指定します。
- 165 -
false：
移動後に帳票を出力しない場合に指定します。
例外
OperateForm Exception：
・移動処理でエラーが発生した場合
・移動元論理あて先または移動先論理あて先が存在しない場合
・移動元論理あて先と移動先論理あて先に同じ論理あて先を指定した場合
・移動先に、異なる論理あて先タイプの論理あて先を指定した場合
・ List Manager が開始されていない状態の場合
・ Web手元印刷型の場合で、以下の条件をすべて満たすとき
－ Web 手元印刷（OWF ファイル）用の論理あて先に対し、移動と同時に出力を行った（isOutput パラメータに「true」を指定した
場合）
－移動元と移動先で、帳票を出力するフォルダが同一である
－移動元の帳票が出力先のフォルダに存在する
・移動先論理あて先に論理あて先グループを指定した場合
・移動できない出力状態の場合
java.lang.Illegal ArgumentException：
移動先の論理あて先名に「null」を指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を移動するには、移動元論理あて先および移動先論理あて先の両方に、論理あて先に対する操作権限が必要です。ただし
移動元論理あて先に権限がない場合でも、帳票の作成ユーザであれば移動できます。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
備考
・移動先論理あて先に、すでに同じ帳票が存在していた場合、移動されません。
移動と同時に出力を行う場合（isOutputパラメータに「true」を指定した場合）、移動先論理あて先の帳票が出力されます。移動元
論理あて先の帳票は出力されません。
移動先の帳票の出力状態は、以下のようになります。
－正常に移動が行われた場合、移動後の帳票の出力状態は、移動前と同じになります。
－移動前の帳票の出力状態が「配信依頼」、「接続エラー」の場合、帳票の出力を中止するため、移動後の帳票の出力状態の
初期状態は「中止」となります。
・論理あて先の論理あて先タイプがWeb 手元印刷用の場合、以下のようになります。
－帳票の登録時に出力ファイル名を指定した場合、帳票の移動時には、登録時に指定した出力ファイル名が引き継がれます。
このため、移動と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）、移動元の帳票の出力ファイル名で
出力されます。
－移動元の論理あて先に対応付けされている論理デバイスの出力方法と、移動先の論理あて先に対応付けされている論理デ
バイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
- 166 -
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 桁）の範囲で
す。
- 167 -
帳票の総ページ数が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：
・移動処理でエラーが発生した場合
・移動元論理あて先または移動先論理あて先が存在しない場合
・移動元論理あて先と移動先論理あて先に同じ論理あて先を指定した場合
・移動先に、異なる論理あて先タイプの論理あて先を指定した場合
・ List Manager が開始されていない状態の場合
・ Web手元印刷型の場合で、以下の条件をすべて満たすとき
－ Web 手元印刷（OWF ファイル）用の論理あて先に対し、移動と同時に出力を行った（isOutput パラメータに「true」を指定した
場合）
－移動元と移動先で、帳票を出力するフォルダが同一である
－移動元の帳票が出力先のフォルダに存在する
・移動先論理あて先に論理あて先グループを指定した場合
・移動できない出力状態の場合
java.lang.Illegal ArgumentException：
・移動先の論理あて先名に「null」を指定した場合
・開始ページ、終了ページ、印刷部数の値として、Integerオブジェクト以外が指定された場合
・開始ページ、終了ページに0～99999999以外の値を指定した場合
・開始ページに終了ページより大きい値を指定した場合
・印刷部数に0～999以外の値を指定した場合
・メッセージ通知先の値としてStringオブジェクト以外を指定した場合
・ printoutOptionsパラメータの各キーに「null」が指定された場合
・ printoutOptionsパラメータに指定できないキーを指定した場合
・ printoutOptionsパラメータに有効なキーが存在しない場合
- 168 -
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・帳票を移動するには、移動元論理あて先および移動先論理あて先の両方に、論理あて先に対する操作権限が必要です。ただ
し、移動元論理あて先に権限がない場合でも、帳票の作成ユーザであれば、移動できます。
・帳票の出力状態によって、操作できない場合があります。帳票の出力状態と帳票の操作の関係については、以下を参照してください。
⇒“2.3 帳票の出力状態と帳票の操作の関係”
・ printoutOptionsパラメータに「null」を指定した場合は、開始ページ、終了ページ、印刷部数に「0」が指定されたとみなされ、メッセー
ジ通知先は帳票登録時のメッセージ通知先となります。
備考
・移動先論理あて先に、すでに同じ帳票が存在していた場合、移動されません。
移動と同時に出力を行う場合（isOutputパラメータに「true」を指定した場合）、移動先論理あて先の帳票が出力されます。移動元
論理あて先の帳票は出力されません。
移動先の帳票の出力状態は、以下のようになります。
－正常に移動が行われた場合、移動後の帳票の出力状態は、移動前と同じになります。
－移動前の帳票の出力状態が「配信依頼」、「接続エラー」の場合、帳票の出力を中止するため、移動後の帳票の出力状態の
初期状態は「中止」となります。
・論理あて先の論理あて先タイプがWeb 手元印刷用の場合、以下のようになります。
－帳票の登録時に出力ファイル名を指定した場合、帳票の移動時には、登録時に指定した出力ファイル名が引き継がれます。
このため、移動と同時に出力を行った場合（isOutput パラメータに「true」を指定した場合）、移動元の帳票の出力ファイル名で
出力されます。
－移動元の論理あて先に対応付けされている論理デバイスの出力方法と、移動先の論理あて先に対応付けされている論理デ
バイスの出力方法が異なる場合、実際に出力する出力方法とは異なる拡張子のファイルが作成される場合があります。
・メッセージ通知先に、複数の通知先を指定することはできません。
public void
createOutputData(OutputStream out, LMParametersList outputOptions)
throws OperateFormException, java.lang.IllegalArgumentException, java.lang.IllegalStateException
用途
Webクライアントからの留置き帳票の手元出力を行う場合、留置き帳票の手元出力用データを生成します。
パラメータ
out：
留置き帳票の手元出力用データを書き込むストリームを指定します。
outputOptions：
留置き帳票の手元出力用データのオプションを、LMParameterKeyクラスの留置き帳票の手元出力用データのオプションを以下の
キーで指定します。「null」を指定した場合、各キーの初期値が指定されたとみなされます。
－ PARAM_CONTENT_TYPE（留置き帳票の手元出力用データの種別）
生成する留置き帳票の手元出力用データの種別を指定します。指定できる値は、ユーザアプリケーション種別によって、以下
のように異なります。
- 169 -
運用形態
帳票配信型
ユーザアプリケーション種別
指定できる値
COBOL アプリケーション連携機能
を利用するユーザアプリケーション
OPTION_CONTENT_TY
PE_OWF
(*1)
OWFファイル
List Manager 帳票出力インフェー
スを利用するユーザアプリケーショ
ン
OPTION_CONTENT_TY
PE_OWF
(*1)
OWFファイル
OPTION_CONTENT_TY
PE_PDF
PDFファイル
OPTION_CONTENT_TY
PE_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」以外を指定した場合、無効となります。
- 170 -
－ 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：
・データを書き込むストリームが「null」の場合
・ outputOptionsパラメータの各キーに「null」が指定された場合
・ outputOptionsパラメータに指定できないキーを指定した場合
・ outputOptionsパラメータに有効なキーが存在しない場合
・留置き帳票の手元出力用データの種別に、無効なフィールドを指定した場合
・開始ページ、終了ページに、Integerオブジェクト以外を指定した場合
・開始ページ、終了ページに、0～99999999以外の値を指定した場合
・開始ページに、終了ページの値より大きい値を指定した場合
・ OWFファイル生成時、開始ページまたは終了ページに「0」以外を指定した場合
・ Webブラウザを閉じるかどうかの指定に、無効なフィールドを指定した場合
・印刷時の印刷画面の表示指定に、無効なフィールドを指定した場合
java.lang.Illegal StateException：
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
・留置き帳票の手元出力用データを生成するには、論理あて先に対する操作権限が必要です。
備考
・留置き帳票の手元出力用データ生成時のページ数と実際に出力されるページ数が異なる場合があります。
3.9.3 FormFilterConditionクラス
帳票を検索するときの検索条件を指定するクラスです。
LogicalDestination クラス、およびFormManagerクラスで使用されます。
java.lang.Object
└com.fujitsu.listmanager.operate.FormFilterCondition
- 171 -
public class FormFilterCondition
extends java.lang.Object
ポイント
・検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカー
ド文字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われな
い場合があります。
・検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定して、
空白が設定されている情報を絞り込むことはできません。
3.9.3.1 コンストラクタの概要
FormFilterConditionクラスのコンストラクタを以下に示します。
FormFilterConditionクラスのコンストラクタ~
コンストラクタの概要
FormFilterCondition()
FormFilterConditionオブジェクトを生成します。
3.9.3.2 メソッドの概要
FormFilterConditionクラスのメソッドを以下に示します。
FormFilterConditionクラスのメソッド
メソッドの概要
java.lang.String
getFormID()
帳票の絞り込み条件として設定されている、帳票IDを取得します。
java.lang.String
getRequestClient()
帳票の絞り込み条件として設定されている、依頼元端末を取得します。
java.lang.String
getCreateUser()
帳票の絞り込み条件として設定されている、作成ユーザを取得します。
java.util.Date
getCreateDatetimeFrom()
帳票の絞り込み条件として設定されている、作成日時（起点）を取得します。
java.util.Date
getCreateDatetimeTo()
帳票の絞り込み条件として設定されている、作成日時（終点）を取得します。
java.lang.Boolean
getFinished()
帳票の絞り込み条件として設定されている、出力完了を取得します。
java.lang.String
getName()
帳票の絞り込み条件として設定されている、帳票名を取得します。
java.lang.String
getTitle()
帳票の絞り込み条件として設定されている、タイトルを取得します。
java.lang.String
getComment()
帳票の絞り込み条件として設定されている、コメントを取得します。
java.util.Date
getSaveLimitDateFrom()
帳票の絞り込み条件として設定されている、保存期限（起点）を取得します。
- 172 -
メソッドの概要
java.util.Date
getSaveLimitDateTo()
帳票の絞り込み条件として設定されている、保存期限（終点）を取得します。
int[]
getOutputStatus()
帳票の絞り込み条件として設定されている、出力状態を取得します。
java.lang.String[]
getOperatorIdInfo()
帳票の絞り込み条件として設定されている、業務あて先を取得します。
java.lang.String
getPrintoutUserID()
帳票の絞り込み条件として設定されている、最終出力者IDを取得します。
java.util.Data
getPrintoutDatetimeFrom()
帳票の絞り込み条件として設定されている、出力依頼日時（起点）を取得しま
す。
java.util.Data
getPrintoutDatetimeTo()
帳票の絞り込み条件として設定されている、出力依頼日時（終点）を取得しま
す。
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を取得します。
- 173 -
メソッドの概要
void
setFormID(java.lang.String formID)
帳票の絞り込み条件として、帳票IDを指定します。
void
setRequestClient(java.lang.String requestClient)
帳票の絞り込み条件として、依頼元端末の「ホスト名」または「IPアドレス」を指
定します。
void
setCreateUser(java.lang.String createUser)
帳票の絞り込み条件として、作成ユーザを指定します。
void
setCreateDatetime(java.util.Date from,java.util.Date to)
帳票の絞り込み条件として、作成日時を指定します。
void
setFinished(java.lang.Boolean finished)
帳票の絞り込み条件として、出力完了を指定します。
void
setName(java.lang.String name)
帳票の絞り込み条件として、帳票名を指定します。
void
setTitle(java.lang.String title)
帳票の絞り込み条件として、タイトルを指定します。
void
setComment(java.lang.String comment)
帳票の絞り込み条件として、コメントを指定します。
void
setSaveLimitDate(java.util.Date from,java.util.Date to)
帳票の絞り込み条件として、保存期限を指定します。
void
setOutputStatus(int[] outputStatus)
帳票の絞り込み条件として、出力状態を指定します。
void
setOperatorIdInfo(java.lang.String[] operatorIdInfo)
帳票の絞り込み条件として、業務あて先を指定します。
void
setPrintoutUserID(java.lang.String printoutUserID)
帳票の絞り込み条件として、最終出力者IDを指定します。
void
setPrintoutDatetime(java.util.Date from,java.util.Date to)
帳票の絞り込み条件として、出力依頼日時を指定します。
void
setCustomizeItem1(java.lang.String customizeItem1)
帳票の絞り込み条件として、カスタマイズ項目1を指定します。
void
setCustomizeItem2(java.lang.String customizeItem2)
帳票の絞り込み条件として、カスタマイズ項目2を指定します。
void
setCustomizeItem3(java.lang.String customizeItem3)
帳票の絞り込み条件として、カスタマイズ項目3を指定します。
void
setCustomizeItem4(java.lang.String customizeItem4)
帳票の絞り込み条件として、カスタマイズ項目4を指定します。
void
setCustomizeItem5(java.lang.String customizeItem5)
帳票の絞り込み条件として、カスタマイズ項目5を指定します。
void
setCustomizeItem6(java.lang.String customizeItem6)
帳票の絞り込み条件として、カスタマイズ項目6を指定します。
- 174 -
メソッドの概要
void
setCustomizeItem7(java.lang.String customizeItem7)
帳票の絞り込み条件として、カスタマイズ項目7を指定します。
void
setCustomizeItem8(java.lang.String customizeItem8)
帳票の絞り込み条件として、カスタマイズ項目8を指定します。
void
setCustomizeItem9(java.lang.String customizeItem9)
帳票の絞り込み条件として、カスタマイズ項目9を指定します。
void
setCustomizeItem10(java.lang.String customizeItem10)
帳票の絞り込み条件として、カスタマイズ項目10を指定します。
void
setCustomizeItem11(java.lang.String customizeItem11)
帳票の絞り込み条件として、カスタマイズ項目11を指定します。
void
setCustomizeItem12(java.lang.String customizeItem12)
帳票の絞り込み条件として、カスタマイズ項目12を指定します。
void
setCustomizeItem13(java.lang.String customizeItem13)
帳票の絞り込み条件として、カスタマイズ項目13を指定します。
ポイント
各帳票属性については、オンラインマニュアル“帳票印刷配信機能セットアップガイド”を参照してください。
3.9.3.3 コンストラクタの詳細
public
FormFilterCondition()
用途
FormFilterConditionオブジェクトを生成します。
3.9.3.4 メソッドの詳細
public java.lang.String
getFormID()
用途
帳票の絞り込み条件として設定されている、帳票IDを取得します。
戻り値
帳票ID
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getRequestClient()
- 175 -
用途
帳票の絞り込み条件として設定されている、依頼元端末を取得します。
戻り値
依頼元端末
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCreateUser()
用途
帳票の絞り込み条件として設定されている、作成ユーザを取得します。
戻り値
作成ユーザ
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.util.Date
getCreateDatetimeFrom()
用途
帳票の絞り込み条件として設定されている、作成日時（起点）を取得します。
作成日時の起点（setCreateDatetimeメソッドのfromパラメータ）のみ指定して、終点（setCreateDatetimeメソッドのtoパラメータ）に「null」
を指定した場合、指定した作成日時（起点）以降の帳票が取得の対象になります。
戻り値
作成日時（起点）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.util.Date
getCreateDatetimeTo()
用途
帳票の絞り込み条件として設定されている、作成日時（終点）を取得します。
作成日時の起点（setCreateDatetimeメソッドのfromパラメータ）に「null」を指定して、終点（setCreateDatetimeメソッドのtoパラメータ）の
み指定した場合、指定した作成日時（終点）以前の帳票が取得の対象になります。
戻り値
作成日時（終点）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.Boolean
getFinished()
- 176 -
用途
帳票の絞り込み条件として設定されている、出力完了を取得します。
戻り値
Boolean.TRUE（プリミティブ値trueに対応するBooleanオブジェクト）：
出力が完了した場合
Boolean.FALSE（プリミティブ値falseに対応するBooleanオブジェクト）：
出力が完了していない場合
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getName()
用途
帳票の絞り込み条件として設定されている、帳票名を取得します。
戻り値
帳票名
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getTitle()
用途
帳票の絞り込み条件として設定されている、タイトルを取得します。
戻り値
タイトル
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getComment()
用途
帳票の絞り込み条件として設定されている、コメントを取得します。
戻り値
コメント
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.util.Date
- 177 -
getSaveLimitDateFrom()
用途
帳票の絞り込み条件として設定されている、保存期限（起点）を取得します。
戻り値
保存期限（起点）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.util.Date
getSaveLimitDateTo()
用途
帳票の絞り込み条件として設定されている、保存期限（終点）を取得します。
戻り値
保存期限（終点）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public int[]
getOutputStatus()
用途
帳票の絞り込み条件として設定されている、出力状態を取得します。
戻り値
Formクラスの出力状態を示すフィールドの配列
フィールドの詳細については、以下を参照してください。
⇒“FormクラスのgetOutputStatusメソッドで取得されるフィールド”
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String[]
getOperatorIdInfo()
用途
帳票の絞り込み条件として設定されている業務あて先を取得します。
戻り値
業務あて先の配列
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getPrintoutUserID()
- 178 -
用途
帳票の絞り込み条件として設定されている最終出力者IDを取得します。
戻り値
最終出力者ID
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.util.Date
getPrintoutDatetimeFrom()
用途
帳票の絞り込み条件として設定されている出力依頼日時（起点）を取得します。
戻り値
出力依頼日時（起点）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.util.Date
getPrintoutDatetimeTo()
用途
帳票の絞り込み条件として設定されている出力依頼日時（終点）を取得します。
戻り値
出力依頼日時（終点）
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem1()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目1を取得します。
戻り値
カスタマイズ項目1
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem2()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目2を取得します。
- 179 -
戻り値
カスタマイズ項目2
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem3()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目3を取得します。
戻り値
カスタマイズ項目3
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem4()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目4を取得します。
戻り値
カスタマイズ項目4
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem5()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目5を取得します。
戻り値
カスタマイズ項目5
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem6()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目6を取得します。
戻り値
カスタマイズ項目6
- 180 -
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem7()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目7を取得します。
戻り値
カスタマイズ項目7
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem8()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目8を取得します。
戻り値
カスタマイズ項目8
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem9()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目9を取得します。
戻り値
カスタマイズ項目9
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem10()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目10を取得します。
戻り値
カスタマイズ項目10
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
- 181 -
getCustomizeItem11()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目11を取得します。
戻り値
カスタマイズ項目11
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem12()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目12を取得します。
戻り値
カスタマイズ項目12
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public java.lang.String
getCustomizeItem13()
用途
帳票の絞り込み条件として設定されているカスタマイズ項目13を取得します。
戻り値
カスタマイズ項目13
なお、絞り込み条件が指定されていない場合は「null」が取得されます。
public void
setFormID(java.lang.String formID)
用途
帳票の絞り込み条件として、帳票IDを指定します。
パラメータ
formID：
帳票IDを指定します。
帳票IDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setRequestClient(java.lang.String requestClient)
- 182 -
用途
帳票の絞り込み条件として、依頼元端末を指定します。
依頼元端末は、帳票登録時（ prprint コマンドの -glmrequestterminal オプションや Java インタフェースの setProperty メソッドの
ID_LM_REQUESTTERMINALキーなど）に指定した端末名を指定します。
なお、帳票登録時に端末名を省略した場合、帳票管理サーバのホスト名を指定します。
パラメータ
requestClient：
依頼元端末の「ホスト名」または「IPアドレス」を指定します。
依頼元端末の「ホスト名」または「IPアドレス」の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定
して、検索することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCreateUser(java.lang.String createUser)
用途
帳票の絞り込み条件として、作成ユーザを指定します。
パラメータ
createUser：
作成ユーザを指定します。
作成ユーザの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCreateDatetime(java.util.Date from,java.util.Date to)
throws java.lang.IllegalArgumentException
用途
帳票の絞り込み条件として、作成日時を指定します。
パラメータ
from：
帳票の作成日時の起点を指定します。
時刻は、ミリ秒まで指定できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
to：
帳票の作成日時の終点を指定します。
時刻は、ミリ秒まで指定できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
作成日時の起点と終点の指定方法による絞り込みの動作は、以下のとおりです。
- 183 -
起点
指定あり
終点
指定あり
絞り込みの動作
指定した起点から終点までの期間を対象に、絞り込みが行われます。
（起点≦作成日時≦終点）
指定あり
「null」が指定
されている
指定した起点の日時以降を対象に、絞り込みが行われます。
「null」が指定さ
れている
指定あり
指定した終点の日時までを対象に、絞り込みが行われます。
「null」が指定さ
れている
「null」が指定
されている
（起点≦作成日時）
（作成日時≦終点）
絞り込みは行われません。
例外
java.lang.Illegal ArgumentException：
・終点の日時が起点の日時より前の場合
・起点/終点に西暦10000年以後の日時を指定した場合
public void
setFinished(java.lang.Boolean finished)
用途
帳票の絞り込み条件として、出力完了を指定します。
パラメータ
finished：
出力完了を指定します。
Boolean.TRUE（プリミティブ値trueに対応するBooleanオブジェクト）：
出力が完了した場合に指定します。
Boolean.FALSE（プリミティブ値falseに対応するBooleanオブジェクト）：
出力が完了していない場合に指定します。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setName(java.lang.String name)
用途
帳票の絞り込み条件として、帳票名を指定します。
パラメータ
name：
帳票名を指定します。
帳票名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 184 -
public void
setTitle(java.lang.String title)
用途
帳票の絞り込み条件として、タイトルを指定します。
パラメータ
title：
タイトルを指定します。
タイトルの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setComment(java.lang.String comment)
用途
帳票の絞り込み条件として、コメントを指定します。
パラメータ
comment：
コメントを指定します。
コメントの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setSaveLimitDate(java.util.Date from,java.util.Date to)
throws java.lang.IllegalArgumentException
用途
帳票の絞り込み条件として、保存期限を指定します。
パラメータ
from：
帳票の保存期限の起点を指定します。日付のみ指定できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
to：
帳票の保存期限の終点を指定します。日付のみ指定できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
保存期限の起点と終点の指定方法による絞り込みの動作は、以下のとおりです。
起点
指定あり
終点
指定あり
絞り込みの動作
指定した起点から終点までの期間を対象に、絞り込みが行われます。
- 185 -
起点
終点
絞り込みの動作
（起点≦保存期限≦終点）
指定あり
「null」が指定され
ている
指定した起点の日以降を対象に、絞り込みが行われます。
「null」が指定され
ている
指定あり
指定した終点の日までを対象に、絞り込みが行われます。
「null」が指定され
ている
「null」が指定され
ている
（起点≦保存期限）
（保存期限≦終点）
絞り込みは行われません。
例外
java.lang.Illegal ArgumentException：
・保存期限の終点が起点の日付より前の場合
・起点/終点に西暦10000年以後の日付を指定した場合
public void
setOutputStatus(int[] outputStatus)
throws java.lang.IllegalArgumentException
用途
帳票の絞り込み条件として、出力状態を指定します。
パラメータ
outputStatus：
Formクラスの出力状態を示すフィールドの配列を指定します。
出力状態は複数指定できます。複数指定した場合は論理和条件（OR条件）となります。
フィールドの詳細については、以下を参照してください。
⇒“FormクラスのgetOutputStatusメソッドで取得されるフィールド”
この条件で絞り込みを行わない場合は、「null」を指定します。
例外
java.lang.Illegal ArgumentException：
・無効な出力状態を指定した場合
・同じ出力状態を複数指定した場合
public void
setOperatorIdInfo(java.lang.String[] operatorIdInfo)
throws java.lang.IllegalArgumentException
用途
帳票の絞り込み条件として、業務あて先を指定します。
- 186 -
パラメータ
operatorIdInfo：
帳票の業務あて先を指定します。業務あて先は複数指定できます。複数指定した場合は、論理和条件（OR条件）になります。
業務あて先の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできます。
この条件で絞り込みを行わない場合は、「null」を指定します。
例外
java.lang.Illegal ArgumentException：
配列の要素として「null」を指定した場合
備考
・以下の値を超える絞り込み条件を指定した場合は、動作の保証はできません。
－絞り込み条件として指定する業務あて先は1つの指定につき256バイト以内にしてください。
－帳票の絞り込み条件として業務あて先を複数指定する場合は、10個まで指定できます。
public void
setPrintoutUserID(java.lang.String printoutUserID)
用途
帳票の絞り込み条件として最終出力者IDを指定します。
パラメータ
printoutUserID：
帳票の最終出力者IDを指定します。
最終出力者IDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもできま
す。「アスタリスク（*）」を指定した場合は、最終出力者ID が設定されている帳票、および設定されていない帳票の両方が取得され
ます。
「クエスチョンマーク（?）」と「アスタリスク（*）」を並べて「?*」と指定した場合は、最終出力者IDが設定されている帳票をすべて取得
できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setPrintoutDatetime(java.util.Date from,java.util.Date to)
throws java.lang.IllegalArgumentException
用途
帳票の絞り込み条件として、出力依頼日時を指定します。
パラメータ
from：
帳票の出力依頼日時の起点を指定します。時刻は、ミリ秒まで指定できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 187 -
to：
帳票の出力依頼日時の終点を指定します。時刻は、ミリ秒まで指定できます。
この条件で絞り込みを行わない場合は、「null」を指定します。
出力依頼日時の起点と終点の指定方法による絞り込みの動作は、以下のとおりです。
起点
指定あり
終点
指定あり
絞り込みの動作
指定した起点から終点までの期間を対象に、帳票の絞り込みが行わ
れます。
（起点≦出力依頼日時≦終点）
指定あり
「null」が指定され
ている
指定した起点の日時以降を対象に、帳票の絞り込みが行われます。
「null」が指定されてい
る
指定あり
指定した終点の日時までを対象に、帳票の絞り込みが行われます。
「null」が指定されてい
る
「null」が指定され
ている
（起点≦出力依頼日時）
（出力依頼日時≦終点）
帳票の絞り込みは行われません。
例外
java.lang.Illegal ArgumentException：
・終点の日時が起点の日時より前の場合
・起点/ 終点に西暦10000 年以後の日時を指定した場合
public void
setCustomizeItem1(java.lang.String customizeItem1)
用途
帳票の絞り込み条件として、カスタマイズ項目1を指定します。
パラメータ
customizeItem1：
カスタマイズ項目1を指定します。
カスタマイズ項目1の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem2(java.lang.String customizeItem2)
用途
帳票の絞り込み条件として、カスタマイズ項目2を指定します。
パラメータ
customizeItem2：
カスタマイズ項目2を指定します。
- 188 -
カスタマイズ項目2の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem3(java.lang.String customizeItem3)
用途
帳票の絞り込み条件として、カスタマイズ項目3を指定します。
パラメータ
customizeItem3：
カスタマイズ項目3を指定します。
カスタマイズ項目3の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem4(java.lang.String customizeItem4)
用途
帳票の絞り込み条件として、カスタマイズ項目4を指定します。
パラメータ
customizeItem4：
カスタマイズ項目4を指定します。
カスタマイズ項目4の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem5(java.lang.String customizeItem5)
用途
帳票の絞り込み条件として、カスタマイズ項目5を指定します。
パラメータ
customizeItem5：
カスタマイズ項目5を指定します。
カスタマイズ項目5の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
- 189 -
public void
setCustomizeItem6(java.lang.String customizeItem6)
用途
帳票の絞り込み条件として、カスタマイズ項目6を指定します。
パラメータ
customizeItem6：
カスタマイズ項目6を指定します。
カスタマイズ項目6の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem7(java.lang.String customizeItem7)
用途
帳票の絞り込み条件として、カスタマイズ項目7を指定します。
パラメータ
customizeItem7：
カスタマイズ項目7を指定します。
カスタマイズ項目7の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem8(java.lang.String customizeItem8)
用途
帳票の絞り込み条件として、カスタマイズ項目8を指定します。
パラメータ
customizeItem8：
カスタマイズ項目8を指定します。
カスタマイズ項目8の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem9(java.lang.String customizeItem9)
- 190 -
用途
帳票の絞り込み条件として、カスタマイズ項目9を指定します。
パラメータ
customizeItem9：
カスタマイズ項目9を指定します。
カスタマイズ項目9の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem10(java.lang.String customizeItem10)
用途
帳票の絞り込み条件として、カスタマイズ項目10を指定します。
パラメータ
customizeItem10：
カスタマイズ項目10を指定します。
カスタマイズ項目10の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem11(java.lang.String customizeItem11)
用途
帳票の絞り込み条件として、カスタマイズ項目11を指定します。
パラメータ
customizeItem11：
カスタマイズ項目11を指定します。
カスタマイズ項目11の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem12(java.lang.String customizeItem12)
用途
帳票の絞り込み条件として、カスタマイズ項目12を指定します。
- 191 -
パラメータ
customizeItem12：
カスタマイズ項目12を指定します。
カスタマイズ項目12の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
public void
setCustomizeItem13(java.lang.String customizeItem13)
用途
帳票の絞り込み条件として、カスタマイズ項目13を指定します。
パラメータ
customizeItem13：
カスタマイズ項目13を指定します。
カスタマイズ項目13の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定して、検索することもでき
ます。
この条件で絞り込みを行わない場合は、「null」を指定します。
3.10 クラスの詳細（ソート指定）
ソート指定のクラスの詳細について説明します。
ポイント
情報を一覧取得するメソッドの実行時、メソッドが実行されるたびに最新の情報を取得します。
例えば、同じパラメータでメソッドを連続で実行した場合、メソッドの実行の間に情報が更新されていれば、取得される情報が違うもの
になる可能性があります。
3.10.1 SortOrderクラス
一覧で取得する結果や検索結果のソート順やソート項目を指定するクラスです。
java.lang.Object
└com.fujitsu.listmanager.operate.SortOrder
public class SortOrder
extends java.lang.Object
以下のクラスのメソッドで取得した結果を一覧するときにソート項目を指定できます。
クラス
LMUserManager
LMUser
メソッド
getUsers
List Managerのユーザの取得
getUserGroups
List Managerのユーザグループの取得
getUserNames
指定したユーザIDに対応するユーザ名（フル
ネーム）を取得
- 192 -
クラス
メソッド
getUserGroupNames
指定したユーザグループIDに対応するユーザ
グループ名を取得
LogicalDestinationManager
getLogicalDestinations
論理あて先の取得
LogicalDeviceManager
getLogicalDevices
論理デバイスの取得
LogicalDestination
getForms
論理あて先内の帳票の取得
FormManager
getForms
帳票の取得
ソート項目の指定には、“3.10.1.1 フィールドの概要”に記載されているフィールドを使用します。
上記の各メソッドで指定できるソート項目は、以下のとおりです。
指定できるソート項目
メソッド
ソート項目
getUsers
ITEM_USER_ID
ユーザID
（ユーザ取得）
ITEM_USER_FULLNAME
フルネーム
getuserNames
ITEM_USER_ID
ユーザID
（ユーザ名の一覧取
得）
ITEM_USER_FULLNAME
フルネーム
getUserGroups
ITEM_USER_GROUP_ID
ユーザグループID
（ユーザグループ取
得）
ITEM_USER_GROUP_NAME
ユーザグループ名
getUserGroupNames
ITEM_USER_GROUP_ID
ユーザグループID
（ユーザグループ名の
一覧取得）
ITEM_USER_GROUP_NAME
ユーザグループ名
getLogical
Destinations
ITEM_DESTINATION_NAME
論理あて先名
ITEM_DESTINATION_TYPE
論理あて先タイプ
ITEM_DESTINATION_PRIORITY
優先度
ITEM_DESTINATION_ACTIVE
論理あて先の状態
ITEM_DESTINATION_ERROR_STATU
S
出力エラー状態
ITEM_DEVICE_NAME
論理デバイス名
ITEM_DEVICE_COMMENT
コメント（出力先）
ITEM_DEVICE_OUTPUT_METHOD
論理デバイスの出力方法
ITEM_CUSTOMIZE_ITEM1
カスタマイズ項目1
ITEM_CUSTOMIZE_ITEM2
カスタマイズ項目2
ITEM_CUSTOMIZE_ITEM3
カスタマイズ項目3
ITEM_CUSTOMIZE_ITEM4
カスタマイズ項目4
ITEM_CUSTOMIZE_ITEM5
カスタマイズ項目5
getLogicalDevices
ITEM_DEVICE_NAME
論理デバイス名
（論理デバイス取得）
ITEM_DEVICE_OUTPUT_METHOD
出力方法
ITEM_DEVICE_HOST_NAME
通信対象コンピュータ名
ITEM_DEVICE_COMMENT
コメント（出力先）
（論理あて先取得）
- 193 -
メソッド
ソート項目
ITEM_DEVICE_DIVISION
論理デバイス区分
ITEM_CUSTOMIZE_ITEM1
カスタマイズ項目1
ITEM_CUSTOMIZE_ITEM2
カスタマイズ項目2
ITEM_CUSTOMIZE_ITEM3
カスタマイズ項目3
ITEM_CUSTOMIZE_ITEM4
カスタマイズ項目4
ITEM_CUSTOMIZE_ITEM5
カスタマイズ項目5
ITEM_CUSTOMIZE_ITEM6
カスタマイズ項目6
ITEM_CUSTOMIZE_ITEM7
カスタマイズ項目7
ITEM_CUSTOMIZE_ITEM8
カスタマイズ項目8
getForms
ITEM_DESTINATION_NAME
論理あて先名
（帳票取得）
ITEM_FORM_ID
帳票ID
ITEM_FORM_REQUEST_CLIENT
依頼元端末
ITEM_FORM_CREATE_USER
作成ユーザ
ITEM_FORM_CREATE_DATETIME
作成日時
ITEM_FORM_FINISHED
出力完了
ITEM_FORM_NAME
帳票名
ITEM_FORM_TITLE
タイトル
ITEM_FORM_COMMENT
コメント
ITEM_FORM_SAVE_LIMIT_DATE
保存期限
ITEM_FORM_OUTPUT_STATUS
出力状態
ITEM_CUSTOMIZE_ITEM1
カスタマイズ項目1
ITEM_CUSTOMIZE_ITEM2
カスタマイズ項目2
ITEM_CUSTOMIZE_ITEM3
カスタマイズ項目3
ITEM_CUSTOMIZE_ITEM4
カスタマイズ項目4
ITEM_CUSTOMIZE_ITEM5
カスタマイズ項目5
ITEM_CUSTOMIZE_ITEM6
カスタマイズ項目6
ITEM_CUSTOMIZE_ITEM7
カスタマイズ項目7
ITEM_CUSTOMIZE_ITEM8
カスタマイズ項目8
ITEM_CUSTOMIZE_ITEM9
カスタマイズ項目9
ITEM_CUSTOMIZE_ITEM10
カスタマイズ項目10
ITEM_CUSTOMIZE_ITEM11
カスタマイズ項目11
ITEM_CUSTOMIZE_ITEM12
カスタマイズ項目12
ITEM_CUSTOMIZE_ITEM13
カスタマイズ項目13
ITEM_FORM_OPERATORID_INFO
業務あて先
ITEM_FORM_PRINTOUT_USERID
最終出力者ID
ITEM_FORM_PRINTOUT_DATETIME
出力依頼日時
ITEM_FORM_PRINTED_PAGE
出力完了ページ数
ITEM_FORM_TOTAL_PAGE
出力ページ数
ITEM_FORM_FORM_TOTAL_PAGE
帳票の総ページ数
- 194 -
3.10.1.1 フィールドの概要
SortOrderクラスのgetOrderメソッドで取得されるフィールドを以下に示します。
SortOrderクラスのgetOrderメソッドで取得されるフィールド
定数
説明
ASCENDING_ORDER
昇順です。
DESCENDING_ORDER
降順です。
SortOrderクラスのgetItemメソッドで取得されるフィールドを以下に示します。
SortOrderクラスのgetItemメソッドで取得されるフィールド
定数
説明
ITEM_CUSTOMIZE_ITEM1
ソート項目は、カスタマイズ項目1です。
ITEM_CUSTOMIZE_ITEM2
ソート項目は、カスタマイズ項目2です。
ITEM_CUSTOMIZE_ITEM3
ソート項目は、カスタマイズ項目3です。
ITEM_CUSTOMIZE_ITEM4
ソート項目は、カスタマイズ項目4です。
ITEM_CUSTOMIZE_ITEM5
ソート項目は、カスタマイズ項目5です。
ITEM_CUSTOMIZE_ITEM6
ソート項目は、カスタマイズ項目6です。
ITEM_CUSTOMIZE_ITEM7
ソート項目は、カスタマイズ項目7です。
ITEM_CUSTOMIZE_ITEM8
ソート項目は、カスタマイズ項目8です。
ITEM_CUSTOMIZE_ITEM9
ソート項目は、カスタマイズ項目9です。
ITEM_CUSTOMIZE_ITEM10
ソート項目は、カスタマイズ項目10です。
ITEM_CUSTOMIZE_ITEM11
ソート項目は、カスタマイズ項目11です。
ITEM_CUSTOMIZE_ITEM12
ソート項目は、カスタマイズ項目12です。
ITEM_CUSTOMIZE_ITEM13
ソート項目は、カスタマイズ項目13です。
ITEM_DESTINATION_ACTIVE
ソート項目は、論理あて先の状態です。
ITEM_DESTINATION_ERROR_STA
TUS
ソート項目は、出力エラー状態です。
ITEM_DESTINATION_NAME
ソート項目は、論理あて先名です。
ITEM_DESTINATION_PRIORITY
ソート項目は、論理あて先の優先度です。
ITEM_DESTINATION_TYPE
ソート項目は、論理あて先タイプです。
ITEM_DEVICE_COMMENT
ソート項目は、論理デバイスのコメント（出力先）です。
ITEM_DEVICE_DIVISION
ソート項目は、論理デバイス区分です。
ITEM_DEVICE_HOST_NAME
ソート項目は、論理デバイスの通信対象コンピュータです。
ITEM_DEVICE_NAME
ソート項目は、論理デバイス名です。
ITEM_DEVICE_OUTPUT_METHOD
ソート項目は、論理デバイスの出力方法です。
ITEM_FORM_COMMENT
ソート項目は、帳票のコメントです。
ITEM_FORM_CREATE_DATETIME
ソート項目は、帳票の作成日時です。
ITEM_FORM_CREATE_USER
ソート項目は、帳票の作成ユーザです。
ITEM_FORM_FINISHED
ソート項目は、帳票の出力完了です。
ITEM_FORM_ID
ソート項目は、帳票IDです。
ITEM_FORM_NAME
ソート項目は、帳票名です。
- 195 -
定数
説明
ITEM_FORM_OUTPUT_STATUS
ソート項目は、帳票の出力状態です。
ITEM_FORM_OPERATORID_INFO
ソート項目は、業務あて先です。
ITEM_FORM_PRINTOUT_USERID
ソート項目は、最終出力者IDです。
ITEM_FORM_PRINTOUT_DATETI
ME
ソート項目は、出力依頼日時です。
ITEM_FORM_REQUEST_CLIENT
ソート項目は、帳票の依頼元端末です。
ITEM_FORM_SAVE_LIMIT_DATE
ソート項目は、帳票の保存期限です。
ITEM_FORM_TITLE
ソート項目は、帳票のタイトルです。
ITEM_USER_FULLNAME
ソート項目は、ユーザのフルネームです。
ITEM_USER_GROUP_ID
ソート項目は、ユーザグループIDです。
ITEM_USER_GROUP_NAME
ソート項目は、ユーザグループ名です。
ITEM_USER_ID
ソート項目は、ユーザIDです。
ITEM_FORM_PRINTED_PAGE
ソート項目は、出力完了ページ数です。
ITEM_FORM_TOTAL_PAGE
ソート項目は、出力ページ数です。
ITEM_FORM_FORM_TOTAL_PAGE
ソート項目は、帳票の総ページ数です。
3.10.1.2 コンストラクタの概要
SortOrderクラスのコンストラクタを以下に示します。
SortOrderクラスのコンストラクタ
コンストラクタの概要
SortOrder(int item)
指定したソート項目で、SortOrderクラスのSortOrderオブジェクトを生成します。
SortOrder(int item,int order)
指定したソート項目と並べ順で、SortOrderクラスのSortOrderオブジェクトを生成します。
3.10.1.3 メソッドの概要
SortOrderクラスのメソッドを以下に示します。
SortOrderクラスのメソッド
メソッドの概要
int
getItem()
指定されているソート項目を取得します。
int
getOrder()
昇順/降順の指定を取得します。
void
setOrder(int order)
昇順/降順を指定します。
void
reverseOrder()
並び順を逆にします。
3.10.1.4 コンストラクタの詳細
public
- 196 -
SortOrder(int item)
用途
指定したソート項目で、SortOrderクラスのSortOrderオブジェクトを生成します。並べ順は、昇順になります。
パラメータ
item：
ソート項目を示すフィールド指定します。
public
SortOrder(int item,int order)
throws java.lang.IllegalArgumentException
用途
指定したソート項目と並べ順で、SortOrderクラスのSortOrderオブジェクトを生成します。
パラメータ
item：
ソート項目を示すフィールドを指定します。
order：
昇順/降順を示すフィールドを指定します。
フィールドの詳細については、以下を参照してください。
⇒“SortOrderクラスのgetOrderメソッドで取得されるフィールド”
例外
java.lang.Illegal ArgumentException：
昇順/降順の指定に誤りがある場合
3.10.1.5 メソッドの詳細
public int
getItem()
用途
指定されているソート項目を取得します。
戻り値
ソート項目を示すフィールド
public int
getOrder()
用途
昇順/降順の指定を取得します。
- 197 -
戻り値
昇順/降順を示すフィールド
フィールドの詳細については、以下を参照してください。
⇒“SortOrderクラスのgetOrderメソッドで取得されるフィールド”
public void
setOrder(int order)
throws java.lang.IllegalArgumentException
用途
昇順/降順を指定します。
並べ順の指定を変更するだけであり、すでに取得した一覧の並び順は変更されません。
パラメータ
order：
昇順/降順を示すフィールドを指定します。
フィールドの詳細については、以下を参照してください。
⇒“SortOrderクラスのgetOrderメソッドで取得されるフィールド”
例外
java.lang.Illegal ArgumentException：
昇順/降順の指定に誤りがある場合
public void
reverseOrder()
用途
並び順を逆にします。
昇順が指定されているときは降順に、降順が指定されているときは昇順にします。
並べ順の指定を変更するだけであり、すでに取得した一覧の並び順は変更されません。
3.11 クラスの詳細（一覧取得）
一覧取得のクラスの詳細について説明します。
ポイント
情報を一覧取得するメソッドの実行時、メソッドが実行されるたびに最新の情報を取得します。
例えば、同じパラメータでメソッドを連続で実行した場合、メソッドの実行の間に情報が更新されていれば、取得される情報が違うもの
になる可能性があります。
3.11.1 ListResultクラス
情報を一覧で取得した結果を保持するクラスです。
取得結果の配列と、このクラスが保持している取得結果以外に、同じ検索条件に該当するものがあるかどうかを取得できます。
- 198 -
java.lang.Object
└com.fujitsu.listmanager.operate.ListResult
public class ListResult
extends java.lang.Object
3.11.1.1 メソッドの概要
ListResultクラスのメソッドを以下に示します。
ListResultクラスのメソッド
メソッドの概要
java.lang.Object[]
getList()
取得結果の配列を取得します。
boolean
hasMoreResult()
このクラスが保持している取得結果以外に、同じ検索条件に該当するものがあ
るかどうかを取得します。
int
getResultCount()
このクラスが保持している取得結果の件数を取得します。
3.11.1.2 メソッドの詳細
public java.lang.Object[]
getList()
用途
取得結果の配列を取得します。
戻り値
取得結果の配列
取得した件数が0件の場合は、長さ0の配列が取得されます。
public boolean
hasMoreResult()
用途
このクラスが保持している取得結果以外に、同じ検索条件に該当するものがあるかどうかを取得します。
戻り値
true：
取得結果以外に、同じ検索条件に該当するものがある場合
false：
取得結果以外に、同じ検索条件に該当するものがない場合
public int
- 199 -
getResultCount()
用途
このクラスが保持している取得結果の件数を取得します。
戻り値
取得結果の件数
3.12 クラスの詳細（パラメータ関連）
帳票管理Javaインタフェースでは、以下の情報をパラメータ関連クラスとして引数に指定し、メソッドの呼び出しができます。
・ログイン情報を指定するキー
・ログアウト情報を指定するキー
・帳票出力時のオプションを指定するキー
・プレビュー用データの生成のオプションを指定するキー
・留置き帳票の手元出力用データの生成時のオプションを指定するキー
・帳票属性の更新を指定するキー
3.12.1 LMParameterKeyクラス
LMParameter クラス（パラメータ基本クラス）に保持するパラメータの「キー」および「値」として指定するフィールドが定義されているクラ
スです。
java.lang.Object
└com.fujitsu.listmanager.operate.LMParameterKey
public class LMParameterKey
extends java.lang.Object
3.12.1.1 フィールドの概要
LMParameterKeyクラスのキーとして指定するフィールドを以下に示します。
LMParameterKeyクラスのキーとして指定するフィールド
定数
説明
PARAM_LOGIN_TERMINAL
ログイン情報として、端末識別子パラメータを指定するキーで
す。
PARAM_LOGIN_OPERATERINFO
ログイン情報として、出力ユーザを指定するキーです。
PARAM_LOGOUT_FACTOR
ログアウトの要因を指定するキーです。
PARAM_PRINTOUT_START_PAGE
帳票出力時の開始ページを指定するキーです。
PARAM_PRINTOUT_END_PAGE
帳票出力時の終了ページを指定するキーです。
PARAM_PRINTOUT_COPY
帳票出力時の印刷部数を指定するキーです。
PARAM_PRINTOUT_RESPONSE_MES
SAGE
帳票出力時のメッセージ通知先（返答メッセージ/応答メッセー
ジ）を指定するキーです。
PARAM_PRINTOUT_NOTICE_MESSA
GE
帳票出力時のメッセージ通知先（通知メッセージ）を指定する
キーです。
PARAM_FORM_CUSTOMIZEITEM1
帳票のカスタマイズ項目1を指定するキーです。
- 200 -
定数
説明
PARAM_FORM_CUSTOMIZEITEM2
帳票のカスタマイズ項目2を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM3
帳票のカスタマイズ項目3を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM4
帳票のカスタマイズ項目4を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM5
帳票のカスタマイズ項目5を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM6
帳票のカスタマイズ項目6を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM7
帳票のカスタマイズ項目7を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM8
帳票のカスタマイズ項目8を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM9
帳票のカスタマイズ項目9を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM10
帳票のカスタマイズ項目10を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM11
帳票のカスタマイズ項目11を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM12
帳票のカスタマイズ項目12を指定するキーです。
PARAM_FORM_CUSTOMIZEITEM13
帳票のカスタマイズ項目13を指定するキーです。
PARAM_FORM_OPERATORID_INFO
帳票の業務あて先を指定するキーです。
PARAM_START_PAGE
プレビュー用、または留置き帳票の手元出力用データの生成を
開始するページを指定するキーです。
PARAM_END_PAGE
プレビュー用、または留置き帳票の手元出力用データの生成を
終了するページを指定するキーです。
PARAM_PRINTDIALOG
印刷時の印刷画面の表示に関する指定を行うキーです。
PARAM_WEBBROWSER_CLOSED
印刷終了後にWeb ブラウザを閉じるかどうかを指定するキーで
す。
PARAM_OUTPUT_MASKED
プレビュー時の印刷の抑止を指定するキーです。
PARAM_CONTENT_TYPE
生成されるプレビュー用データ種別、または留置き帳票の手元
出力用データ種別のキーです。
LMParameterKeyクラスのPARAM_LOGOUT_FACTORキーの値として指定するフィールドを以下に示します。
LMParameterKeyクラスのPARAM_LOGOUT_FACTORキーの値として指定するフィールド
定数
説明
PARAM_LOGOUT_VALUE_LOGOUT
ログアウト操作によってログアウトします。
PARAM_LOGOUT_VALUE_SESSIONT
IMEOUT
セションタイムアウトによってログアウトします。
LMParameterKeyクラスのPARAM_PRINTDIALOGキーの値として指定するフィールドを以下に示します。
LMParameterKeyクラスのPARAM_PRINTDIALOGキーの値として指定するフィールド
定数
説明
OPTION_USE_APPLICATION
帳票登録時の指定にしたがいます。
OPTION_PRINTDIALOG_DISABLE
印刷時の印刷画面を表示しません。
OPTION_PRINTDIALOG_OPEN
印刷時の印刷画面を表示します。
LMParameterKeyクラスのPARAM_WEBBROWSER_CLOSEDキーの値として指定するフィールドを以下に示します。
- 201 -
LMParameterKeyクラスのPARAM_WEBBROWSER_CLOSEDキーの値として指定するフィールド
定数
説明
OPTION_USE_APPLICATION
帳票登録時の指定にしたがいます。
OPTION_WEBBROWSER_CLOSED
印刷終了後、Webブラウザを自動的に閉じます。
OPTION_WEBBROWSER_OPENED
印刷終了後、Webブラウザを開いた状態にします。
LMParameterKeyクラスのPARAM_OUTPUT_MASKEDキーの値として指定するフィールドを以下に示します。
LMParameterKeyクラスのPARAM_OUTPUT_MASKEDキーの値として指定するフィールド
定数
説明
OPTION_USE_APPLICATION
帳票登録時の指定にしたがいます。
OPTION_OUTPUT_MASKED_FALSE
プレビュー時の印刷を抑止しません。
OPTION_OUTPUT_MASKED_TRUE
プレビュー時の印刷を抑止します。
OPTION_OUTPUT_MASKED_TWICE_
DISABLE
2 重印刷を抑止します。
LMParameterKeyクラスのPARAM_CONTENT_TYPEキーの値として指定するフィールドを以下に示します。
LMParameterKeyクラスのPARAM_CONTENT_TYPEキーの値として指定するフィールド
定数
説明
OPTION_CONTENT_TYPE_OWF
種別はOWF ファイルです。
OPTION_CONTENT_TYPE_PDF
種別はPDF ファイルです。
3.12.2 LMParameterクラス
このクラスは、帳票管理Java インタフェースの各メソッドを呼び出す場合に、メソッドに指定する引数（パラメータと設定値）を「キー」と「値」
の対応関係で保持するパラメータ基本クラスです。
LMParameterKey クラスで指定した以下の「キー」と「値」を保持し、帳票管理Java インタフェースの各メソッドの引数（パラメータと設定
値）として設定することができます。
・ログイン情報パラメータ
・ログアウト情報パラメータ
・帳票出力時のオプションパラメータ
・プレビュー用データの生成のオプションパラメータ
・留置き帳票の手元出力用データの生成時のオプションパラメータ
・帳票属性更新時のパラメータ
java.lang.Object
└com.fujitsu.listmanager.operate.LMParameter
public class LMParameter
extends java.lang.Object
3.12.2.1 コンストラクタの概要
LMParameterクラスのコンストラクタを以下に示します。
- 202 -
LMParameterクラスのコンストラクタ
コンストラクタの概要
LMParameter()
空のLMParameterクラスを生成します。
LMParameter(LMParameterKey key, java.lang.Object value)
キーと値を指定して、LMParameterクラスを生成します。
3.12.2.2 メソッドの概要
LMParameterクラスのメソッドを以下に示します。
LMParameterクラスのメソッド
メソッドの概要
void
setKey(LMParameterKey key)
キーを指定します。
void
setValue(java.lang.Object value)
値を指定します。
LMParameterKey
getKey()
登録されているキーを取得します。
java.lang.Object
getValue()
登録されている値を取得します。
3.12.2.3 コンストラクタの詳細
public
LMParameter()
用途
空のLMParameterクラスを生成します。
public
LMParameter(LMParameterKey key, java.lang.Object value)
throws java.lang.IllegalArgumentException
用途
キーと値を指定して、LMParameterクラスを生成します。
パラメータ
key：
登録するキーをLMParameterKeyクラスのフィールドで指定します。
指定するキーについては、以下を参照してください。
⇒“LMParameterKeyクラスのキーとして指定するフィールド”
value：
オブジェクトまたはキーの値として指定できるフィールドを指定します。
- 203 -
キーの値として指定できるフィールドについては、以下を参照してください。
⇒“LMParameterKeyクラスのPARAM_LOGOUT_FACTORキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_PRINTDIALOGキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_WEBBROWSER_CLOSEDキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_OUTPUT_MASKEDキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_CONTENT_TYPEキーの値として指定するフィールド”
例外
java.lang.Illegal ArgumentException：
登録するキーとして「null」を指定した場合
3.12.2.4 メソッドの詳細
public void
setKey(LMParameterKey key)
throws java.lang.IllegalArgumentException
用途
キーを指定します。
パラメータ
key：
登録するキーをLMParameterKeyクラスのフィールドで指定します。
指定するキーについては、以下を参照してください。
⇒“LMParameterKeyクラスのキーとして指定するフィールド”
例外
java.lang.Illegal ArgumentException：
登録するキーとして「null」を指定した場合
注意
・ LMParametersListオブジェクトにすでに登録されているLMParameterオブジェクトに対してsetKeyメソッドを実行しないでください。
実行した場合、動作の保障はできません。
public void
setValue(java.lang.Object value)
用途
値を指定します。
パラメータ
value：
オブジェクトまたはキーの値として指定できるフィールドを指定します。
キーの値として指定できるフィールドについては、以下を参照してください。
⇒“LMParameterKeyクラスのPARAM_LOGOUT_FACTORキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_PRINTDIALOGキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_WEBBROWSER_CLOSEDキーの値として指定するフィールド”
- 204 -
⇒“LMParameterKeyクラスのPARAM_OUTPUT_MASKEDキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_CONTENT_TYPEキーの値として指定するフィールド”
public LMParameterKey
getKey()
用途
登録されているキーを取得します。
戻り値
登録されているキー
public java.lang.Object
getValue()
用途
登録されている値を取得します。
戻り値
登録されている値
3.12.3 LMParametersListクラス
LMParameterクラス（パラメータ基本クラス）を登録順のリスト形式で保持するクラスです。
指定されたキーと値からLMParameterクラス（パラメータ基本クラス）を生成し、LMParameterListクラスへ登録できます。
登録されたキーは登録順に管理されるため、登録順のインデックス番号を指定して登録データを取得することが可能です。
java.lang.Object
└com.fujitsu.listmanager.operate.LMParametersList
public class LMParametersList
extends java.lang.Object
3.12.3.1 コンストラクタの概要
LMParametersListクラスのコンストラクタを以下に示します。
LMParametersListクラスのコンストラクタ
コンストラクタの概要
LMParametersList()
LMParametersListクラスを生成します。
3.12.3.2 メソッドの概要
LMParametersListクラスのメソッドを以下に示します。
LMParametersListクラスのメソッド
- 205 -
メソッドの概要
void
add(LMParameterKey key, java.lang.Object value)
キーと値を指定してLMParameterを生成し、LMParametersListクラスへ登録しま
す。
void
add(LMParameter param)
LMParameterクラスをLMParametersListクラスへ登録します。
LMParameter
getParameterAt(int index)
インデックスの位置に登録されているLMParameterクラスを取得します。
LMParameter
getParameterAt(LMParameterKey key)
キーを指定して、登録されているLMParameterクラスを取得します。
LMParameterKey
getParameterKey(int index)
インデックスの位置に登録されているキーを取得します。
java.lang.Object
getParameterValue (int index)
インデックスの位置に登録されている値を取得します。
java.lang.Object
getParameterValue(LMParameterKey key)
キーを指定して、登録されている値を取得します。
int
size()
登録数を取得します。
3.12.3.3 コンストラクタの詳細
public
LMParametersList()
用途
LMParametersListクラスを生成します。
3.12.3.4 メソッドの詳細
public void
add(LMParameterKey key, java.lang.Object value)
throws java.lang.IllegalArgumentException
用途
キーと値を指定してLMParameterを生成し、LMParametersListクラスへ登録します。
パラメータ
key：
登録するキーをLMParameterKeyクラスのフィールドで指定します。
指定するキーについては、以下を参照してください。
⇒“LMParameterKeyクラスのキーとして指定するフィールド”
value：
オブジェクトまたはキーの値として指定できるフィールドを指定します。
- 206 -
キーの値として指定できるフィールドについては、以下を参照してください。
⇒“LMParameterKeyクラスのPARAM_LOGOUT_FACTORキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_PRINTDIALOGキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_WEBBROWSER_CLOSEDキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_OUTPUT_MASKEDキーの値として指定するフィールド”
⇒“LMParameterKeyクラスのPARAM_CONTENT_TYPEキーの値として指定するフィールド”
例外
java.lang.Illegal ArgumentException：
・登録するキーとして「null」を指定した場合
・キーがすでに登録されている場合
public void
add(LMParameter param)
throws java.lang.IllegalArgumentException
用途
LMParameterクラスをLMParametersListクラスへ登録します。
パラメータ
param：
登録するLMParameterクラスのオブジェクトを指定します。
例外
java.lang.Illegal ArgumentException：
・登録するキーとして「null」を指定した場合
・ LMParameterクラスで指定したキーがすでに登録されている場合
public LMParameter
getParameterAt(int index)
用途
インデックスの位置に登録されているLMParameterクラスを取得します。
パラメータ
index：
取得する登録データのインデックス番号を「0」からの通番で指定します。
戻り値
登録されているLMParameterクラスのオブジェクト
なお、範囲外のインデックスを指定した場合は「null」を取得します。
public LMParameter
getParameterAt(LMParameterKey key)
- 207 -
用途
キーを指定して、登録されているLMParameterクラスを取得します。
パラメータ
key：
取得する登録データのキーをLMParameterKeyクラスのフィールドで指定します。
戻り値
登録されているLMParameterクラスのオブジェクト
なお、未登録のキーを指定した場合は「null」を取得します。
public LMParameterKey
getParameterKey(int index)
用途
インデックスの位置に登録されているキーを取得します。
パラメータ
index：
取得する登録データのインデックス番号を「0」からの通番で指定します。
戻り値
インデックスの位置に登録されているキー
なお、範囲外のインデックスを指定した場合は「null」を取得します。
public java.lang.Object
getParameterValue (int index)
用途
インデックスの位置に登録されている値を取得します。
パラメータ
index：
取得する登録データのインデックス番号を「0」からの通番で指定します。
戻り値
インデックスの位置に登録されている値
なお、範囲外のインデックスを指定した場合は「null」を取得します。
public java.lang.Object
getParameterValue(LMParameterKey key)
- 208 -
用途
指定されたキーで登録されている値を取得します。
パラメータ
key：
取得する登録データのキーをLMParameterKeyクラスのフィールドで指定します。
戻り値
登録されている値
なお、未登録のキーを指定した場合は「null」を取得します。
public int
size()
用途
登録数を取得します。
戻り値
登録数
3.13 例外クラスの詳細
例外クラスの詳細について説明します。
3.13.1 OperateExceptionクラス
帳票管理Javaインタフェースで発生する例外クラスです。
java.lang.Object
└java.lang.Throwable
└java.lang.Exception
└com.fujitsu.listmanager.operate.OperateException
public class OperateException
extends java.lang.Exception
3.13.1.1 コンストラクタの概要
OperateExceptionクラスのコンストラクタを以下に示します。
OperateExceptionクラスのコンストラクタ
コンストラクタの概要
OperateException(java.lang.String message,int code)
指定された詳細メッセージ、およびList Manager内部のエラー番号を使用して、OperateExceptionを構築
します。
3.13.1.2 メソッドの概要
OperateExceptionクラスのメソッドを以下に示します。
OperateExceptionクラスのメソッド
- 209 -
メソッドの概要
int
getCode()
List Manager内部のエラー番号を取得します。
void
printStackTrace()
例外オブジェクトとバックトレースを、標準エラーストリームに出力します。
void
printStackTrace(java.io.PrintStream s)
例外オブジェクトとバックトレースを、指定された印刷ストリームに出力します。
void
printStackTrace(java.io.PrintWriter s)
例外オブジェクトとバックトレースを、指定されたプリントライターに出力します。
3.13.1.3 コンストラクタの詳細
public
OperateException(java.lang.String message,int code)
用途
指定された詳細メッセージ、およびList Manager内部のエラー番号を使用して、OperateExceptionを構築します。
パラメータ
message：
詳細メッセージを指定します。
code：
List Manager内部のエラー番号を指定します。
3.13.1.4 メソッドの詳細
public int
getCode()
用途
List Manager内部のエラー番号を取得します。
エラー番号は、クラスjava.lang.Throwableから継承したgetMessageメソッドで取得する詳細メッセージの先頭の番号と同じものです。
戻り値
List Manager内部のエラー番号
public void
printStackTrace()
用途
例外オブジェクトとバックトレースを、標準エラーストリームに出力します。
オーバーライド
クラスjava.lang.Throwable内のprintStackTrace
- 210 -
関連項目
Throwable.printStackTrace()
public void
printStackTrace(java.io.PrintStream s)
用途
例外オブジェクトとバックトレースを、指定された印刷ストリームに出力します。
パラメータ
s：
出力に使用する印刷ストリーム
オーバーライド
クラスjava.lang.Throwable内のprintStackTrace
関連項目
Throwable.printStackTrace(java.io.PrintStream)
public void
printStackTrace(java.io.PrintWriter s)
用途
例外オブジェクトとバックトレースを、指定されたプリントライターに出力します。
パラメータ
s：
出力に使用するプリントライター
オーバーライド
クラスjava.lang.Throwable内のprintStackTrace
関連項目
Throwable.printStackTrace(java.io.PrintWriter)
3.13.2 OperateFormExceptionクラス
帳票に対する操作で発生する例外クラスです。
java.lang.Object
└java.lang.Throwable
└java.lang.Exception
└com.fujitsu.listmanager.operate.OperateException
└com.fujitsu.listmanager.operate.OperateFormException
public class OperateFormException
extends OperateException
- 211 -
3.13.2.1 コンストラクタの概要
OperateFormExceptionクラスのコンストラクタを以下に示します。
OperateFormExceptionクラスのコンストラクタ
コンストラクタの概要
OperateFormException(java.lang.String message,int code,java.lang.String formID,java.lang.String
filename)
指定された詳細メッセージ、List Manager内部のエラー番号、帳票ID、および帳票データファイル名を使
用して、OperateFormExceptionを構築します。
3.13.2.2 メソッドの概要
OperateFormExceptionクラスのメソッドを以下に示します。
OperateFormExceptionクラスのメソッド
メソッドの概要
java.lang.String
getFormID()
エラーになった帳票に対応する帳票IDを取得します。
java.lang.String
getDataFilename()
エラーになった帳票に対応する帳票データファイル名を取得します。
3.13.2.3 コンストラクタの詳細
public
OperateFormException(java.lang.String message,int code,java.lang.String formID,java.lang.String filename)
用途
指定された詳細メッセージ、List Manager内部のエラー番号、帳票ID、および帳票データファイル名を使用して、OperateFormException
クラスを構築します。
パラメータ
message：
詳細メッセージを指定します。
code：
List Manager内部のエラー番号を指定します。
formID：
帳票IDを指定します。
filename：
帳票データファイル名を指定します。
3.13.2.4 メソッドの詳細
public java.lang.String
getFormID()
用途
エラーになった帳票に対応する帳票IDを取得します。
- 212 -
戻り値
帳票ID
public java.lang.String
getDataFilename()
用途
エラーになった帳票に対応する帳票データファイル名を取得します。
戻り値
帳票データファイル名
3.13.3 OperateAllFormsExceptionクラス
論理あて先内の帳票を、一括操作したときに発生する例外クラスです。
java.lang.Object
└java.lang.Throwable
└java.lang.Exception
└com.fujitsu.listmanager.operate.OperateException
└com.fujitsu.listmanager.operate.OperateAllFormsException
public class OperateAllFormsException
extends OperateException
3.13.3.1 コンストラクタの概要
OperateAllFormsExceptionクラスのコンストラクタを以下に示します。
OperateAllFormsExceptionクラスのコンストラクタ
コンストラクタの概要
OperateAllFormsException(java.lang.String message,int code,java.lang.String logicalDestination,int
totalNumber,int successNumber,OperateFormException[] errorForms)
指定された詳細メッセージ、およびList Manager内部のエラー番号を使用して、OperateAllFormsException
を構築します。
3.13.3.2 メソッドの概要
OperateAllFormsExceptionクラスのメソッドを以下に示します。
OperateAllFormsExceptionクラスのメソッド
メソッドの概要
java.lang.String
getLogicalDestinationName()
一括操作を行った論理あて先名を取得します。
int
getTotalNumber()
一括操作の対象となった帳票の数を取得します。
int
getSuccessNumber()
一括操作が成功した帳票の数を取得します。
- 213 -
メソッドの概要
OperateForm
Exception[]
getErrorForms()
エラーになった帳票に対する例外の配列を取得します。
3.13.3.3 コンストラクタの詳細
public
OperateAllFormsException(java.lang.String message,int code,java.lang.String logicalDestination,int totalNumber,int
successNumber,OperateFormException[] errorForms)
用途
指定された詳細メッセージ、およびList Manager内部のエラー番号を使用して、OperateAllFormsExceptionクラスを構築します。
パラメータ
message：
詳細メッセージを指定します。
code：
List Manager内部のエラー番号を指定します。
logicalDestination：
一括操作を行った論理あて先名を指定します。
totalNumber：
一括操作の対象にした帳票の数を指定します。
successNumber：
一括操作が成功した帳票の数を指定します。
errorForms：
帳票に対する一括操作で発生した例外を指定します。
3.13.3.4 メソッドの詳細
public java.lang.String
getLogicalDestinationName()
用途
一括操作を行った論理あて先名を取得します。
戻り値
論理あて先名
public int
getTotalNumber()
用途
一括操作の対象になった帳票の数を取得します。
- 214 -
戻り値
一括操作の対象になった帳票の数
public int
getSuccessNumber()
用途
一括操作が成功した帳票の数を取得します。
戻り値
一括操作が成功した帳票の数
public OperateFormException[]
getErrorForms()
用途
エラーになった帳票に対する例外の配列を取得します。
戻り値
帳票に対する操作で発生した例外の配列
3.14 注意事項
以下に、帳票管理Javaインタフェースに関する注意事項について示します。
●帳票管理アプリケーション使用時の注意事項
・検索条件として指定する値には、以下の制限があります。
－「クエスチョンマーク（?）」および「アスタリスク（*）」はワイルドカード文字として扱われます。「クエスチョンマーク（?）」は任意の1
文字、「アスタリスク（*）」は任意の長さの任意の文字として指定できます。
－「クエスチョンマーク（?）」と「アスタリスク（*）」を使用した場合、パラメータで指定する値に「パーセント（%）」や「アンダーバー
（_）」があると、SQLのワイルドカード文字として処理されるため、目的の検索結果を得られないことがあります。
－検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定
して、空白が設定されている情報を絞り込むことはできません。
・情報を一覧取得するときに、複数の条件（メソッド）を指定した場合は、AND条件として処理されます。
・ List Manager管理データベースに定義している情報で、文字列の末尾に空白を付加している場合、その空白は帳票管理アプリ
ケーションでは取得されません。末尾の空白までの文字が取得されます。
・帳票定義情報に定義した値は、帳票管理アプリケーションで取得されません。
・プリンタ機種、プリンタの接続形態によっては、帳票出力後に、プリンタでエラーが発生した場合、帳票管理アプリケーションで取
得される出力完了ページ数が0ページになることがあります。
下記以外のプリンタを使用した場合、この現象が発生する場合があります。
－ VSP/VS/PS5000シリーズ
－ PrintiaLASERシリーズ（Printianavi搭載機）
上記の現象発生後は、プリンタのエラーを復旧させ、印刷を再開すれば、帳票管理アプリケーションに正しい出力完了ページ数
が取得されます。
- 215 -
・帳票資源の配置場所によってプレビュー用データが生成できない帳票があります。
詳細については、オンラインマニュアル“帳票印刷配信機能運用ガイド”の“2.1.1 List Manager帳票出力インタフェースを利用し
て帳票を配信する場合”を参照してください。
・配信通番、またはコネクタ通番を出力する設定にした帳票のプレビュー用データを生成する場合、帳票管理アプリケーションでは
配信通番またはコネクタ通番は取得されません。
・ OWFファイルのプレビュー用データから印刷する場合、またはプレビュー用データを印刷する場合に「給紙口」を有効にする場
合、以下の注意事項があります。
－ List Creatorデザイナで設計した帳票の場合、帳票の給紙方法には「指定なし」以外を指定しておく必要があります。
－帳票定義体（FORM （またはNetCOBOL に付属のFORM）に付属されているPowerFORMで作成）の場合、用紙/用紙方向に
プリンタ情報ファイルを指定しておく必要があります。
－画面帳票定義体（FORM（またはNetCOBOL に付属のFORM）で作成）の場合、用紙サイズに「指定なし」または「自由」を指
定しておく必要があります。
・帳票管理JavaインタフェースのJarファイル（f3hxcopr.jar、またはf3hxcjop.jar）を複写して使用しないでください。例えば、サーブレッ
ト・コンテナごとにJarファイルを複写した場合、動作の保証はできません。必ずJarファイルをクラスパスに設定して利用してくださ
い。
・帳票管理Javaインタフェースの実行環境とList Manager管理データベースの文字コード系を合致させた環境で環境設定するよう
にしてください。
・帳票管理Javaインタフェースの実行環境とList Manager管理データベースの文字コード系が合致していない場合で、日本語文字
が混在する場合、以下の現象が発生することがあります。
－帳票出力実行時に文字化けや出力エラーとなる場合がある
－帳票管理Javaインタフェースでの取得結果が文字化けする場合がある
詳細および対処方法については、オンラインマニュアル“帳票印刷配信機能トラブルシューティング”の“帳票管理Javaインタ
フェースで、論理あて先のコメントなどを取得したとき、半角文字の「?」になる”を参照してください。
・帳票管理Javaインタフェースで取得される情報のうち、日本語表示域に日本語を入力したにもかかわらず、「アスタリスク（*）」が取
得される場合があります。この場合、該当データは、ロケールや文字コード系の情報が誤った状態で入力された可能性がありま
す。該当データをいったん削除し、正しいロケールや文字コード系を指定した環境で、再度実行してください。
●出力が保留されている帳票に対し、印刷部数を指定して保留解除する場合の注意事項
List Manager帳票出力インタフェースで出力した帳票を保留解除する場合
帳票の出力の保留解除時に、印刷部数を指定した場合と指定しない場合とでは、出力結果が異なります。
例として、2ページの帳票を3部印刷した帳票を保留解除するときの出力結果について、以下の場合ごとに示します。
－印刷部数を指定せずに保留解除した場合
- 部単位で印刷しない場合（ページ単位で印刷する場合）
出力結果 (1)(1)(1)(2)(2)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
- 部単位で印刷する場合
出力結果 (1)(2)(1)(2)(1)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
－印刷部数に「2」を指定して保留解除した場合
- 部単位で印刷しない場合（ページ単位で印刷する場合）
出力結果 (1)(1)(1)(2)(2)(2)(1)(1)(1)(2)(2)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
- 部単位で印刷する場合
出力結果 (1)(2)(1)(2)
- 216 -
(1)：帳票の1ページ目
(2)：帳票の2ページ目
COBOLアプリケーション連携機能で出力した帳票を保留解除する場合
帳票の出力の保留解除時に、プリンタ情報ファイルのCOPYG（複写枚数）で部数を指定して印刷した場合と印刷属性ファイルの
copynumキーで部数を指定して印刷した場合とでは、出力結果が異なります。
例として、2ページの帳票を3部印刷した帳票を保留解除するときの出力結果について、以下の場合ごとに示します。
－印刷部数を指定せずに保留解除した場合
- プリンタ情報ファイルのCOPYG（複写枚数）で印刷部数を指定して印刷した場合
出力結果 (1)(1)(1)(2)(2)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
- 印刷属性ファイルのcopynumキーで印刷部数を指定して印刷した場合
出力結果 (1)(2)(1)(2)(1)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
－印刷部数に「2」を指定して保留解除した場合
- プリンタ情報ファイルのCOPYG（複写枚数）で印刷部数を指定して印刷した場合
出力結果 (1)(1)(1)(2)(2)(2)(1)(1)(1)(2)(2)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
- 印刷属性ファイルのcopynumキーで印刷部数を指定して印刷した場合
出力結果 (1)(2)(1)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
ホスト帳票連携機能で出力した帳票を保留解除する場合
帳票の出力の保留解除時に、印刷部数を指定した場合と指定しない場合では、出力結果が異なります。
例として、2 ページの帳票を3 部印刷した帳票を保留解除するときの出力結果について、以下の場合ごとに示します。
－印刷部数を指定せずに保留解除した場合
出力結果 (1)(2)(1)(2)(1)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
－印刷部数に「2」を指定して保留解除した場合
出力結果 (1)(2)(1)(2)(1)(2)(1)(2)(1)(2)(1)(2)
(1)：帳票の1ページ目
(2)：帳票の2ページ目
●出力が保留されている帳票を解除するとき、メッセージ通知先を省略した場合の注意事項
出力が保留されている帳票を、以下の流れで保留解除した場合に、省略または指定したメッセージ通知先への通知に失敗したとき
は、前回の保留解除時に指定したメッセージ通知先（2)で指定したメッセージ通知先）が有効になります。
1. 帳票登録時、メッセージ通知先を指定し、帳票出力サーバで出力を保留した。
2. 1.の帳票に対し、メッセージ通知先を指定して保留解除した。
3. 2.で保留解除した帳票に応答待ちや出力エラーなどが発生したため、メッセージ通知クライアントから出力を保留した。
●帳票管理Javaインタフェースの例外発生時の注意事項
・ LogicalDestinationクラスの以下のメソッドでスローされるOperateExceptionクラスとOperateAllFormsExceptionクラスについて、これ
らのクラスのgetCodeメソッドで「0x000b0003」を取得、またはクラスjava.lang.Throwableから継承したgetMessageメソッドで「データが
- 217 -
存在しない」を取得した場合、インスタンスが指す論理あて先が存在していません。該当する論理あて先が削除されていないか確
認してください。
－ startメソッド
－ stopメソッド
－ resumeAllFormsメソッド
－ cancelAllFormsメソッド
－ forceCancelAllFormsメソッド
－ deleteAllFormsメソッド
・ LogicalDestinationクラスのchangeDeviceメソッドでスローされるOperateExceptionクラスのgetCodeメソッドで「0x000b0003」を取得、
またはクラスjava.lang.Throwableから継承したgetMessageメソッドで「データが存在しない」を取得した場合、以下の原因が考えられ
ます。
－インスタンスが指す論理あて先が存在しません。
該当の論理あて先が削除されていないか確認してください。
－切り替え先の論理デバイスが存在しません。
切り替え先の論理デバイスが存在するか確認してください。
－切り替え先の論理デバイスの指定に誤りがあります。
切り替え先の論理デバイスの指定が正しいか確認してください。
・ LogicalDestinationクラスのchangeDeviceメソッドでスローされるOperateExceptionクラスのgetCodeメソッドで「0x000c0201」を取得、
またはクラスjava.lang.Throwableから継承したgetMessageメソッドで「すでに配信要求が存在」を取得した場合、インスタンスが指す
論理あて先に、以下の出力状態の帳票が存在するため、出力先を切り替えできません。出力先を切り替える前に論理あて先を停
止し、帳票の出力を中止してください。
－出力エラー
－応答待ち
－出力中
－出力待ち
－出力保留
－配信中
－配信待ち
・ Formクラスの以下のメソッドでスローされるOperateFormExceptionクラスのgetCodeメソッドで「0x000b0003」を取得、またはクラス
java.lang.Throwableから継承したgetMessageメソッドで「データが存在しない」を取得した場合、インスタンスが指す帳票が存在して
いません。該当する帳票が削除されていないか確認してください。
－ printoutメソッド
－ cancelメソッド
－ responseErrorメソッド
－ forceCancelメソッド
－ deleteメソッド
・ FormクラスのcopyメソッドでスローされるOperateFormExceptionクラス、およびLogicalDestinationクラスのcopyAllFormsメソッドでス
ローされるOperateAllFormsExceptionクラスについて、getCodeメソッドで「0x000b0003」を取得、またはクラスjava.lang.Throwableか
ら継承したgetMessageメソッドで「データが存在しない」を取得した場合、以下の原因が考えられます。
－インスタンスが指す帳票または論理あて先が存在しません。
該当の帳票または論理あて先が削除されていないか確認してください。
－複写先の論理あて先が存在しません。
複写先の論理あて先が存在するか確認してください。
- 218 -
－複写先の論理あて先名の指定に誤りがあります。
複写先の論理あて先名の指定が正しいか確認してください。
- 219 -
付録A 帳票管理Javaインタフェースのサポート範囲
ここでは、帳票管理Javaインタフェースにおける機能のサポート範囲について、他のインタフェースと比較して説明します。
A.1 帳票管理Javaインタフェースのサポート範囲
帳票管理Javaインタフェースの機能のサポート範囲について、以下のインタフェースと比較して示します。
・コマンド
－帳票管理サーバの環境設定コマンド
－帳票管理サーバの運用コマンド
・操作画面
操作
帳票管理
Javaインタ
フェース
コマンド
操作画面
操作の分類
操作の詳細
List Manager管理データ
ベースユーザのパスワー
ドの設定
List Manager管理データベースユーザ
のパスワードの設定
×
○
×
×
ユーザ認証
ユーザ認証（ログイン）
○
×
×
○
ユーザ情報の編集
ユーザ情報の定義/変更/削除
×
○
×
×
ユーザ情報の一覧表示（一覧取得）
○
○
×
×
取得した帳票一覧（操作画面では、帳
票一覧画面）の自動更新の変更
○
×
×
○
取得した帳票一覧（操作画面では、帳
票一覧画面）の自動更新間隔の変更
○
×
×
○
帳票の絞り込み条件の保存/変更
○
×
×
○
論理あて先の絞り込み条件の保存/変
更
○
×
×
○
帳票を一覧取得する場合の最大取得
帳票数の変更
○
×
×
×
帳票の一覧取得時に、応答待ちが発
生した帳票の応答メッセージの表示/非
表示
○
×
×
×
応答メッセージを表示させる論理あて
先名の変更
○
×
×
×
ユーザグループ情報の定義/変更/削
除
×
○
×
×
ユーザグループ情報の一覧表示（一覧
取得）
○
○
×
×
用紙コードの定義/変更/削除/一覧表
示
×
○
×
×
帳票属性の定義/変更/削除/一覧表示
×
○
×
×
プリンタモデルコードの定義/変更/削
除/一覧表示/検索
×
○
×
×
プリンタ構成の定義/変更/削除/一覧表
示
×
○
×
×
ユーザごとの帳票管理
情報の編集
ユーザグループ情報の
編集
帳票情報の編集
デバイス情報の編集
- 220 -
帳票管理サー帳票管理サー
バの環境設定バの運用コマ
コマンド
ンド
操作
操作の分類
帳票管理
Javaインタ
フェース
操作の詳細
コマンド
操作画面
帳票管理サー帳票管理サー
バの環境設定バの運用コマ
コマンド
ンド
論理デバイスの定義/変更/削除
×
○
×
×
論理デバイスの一覧表示（一覧取得）
○
○
×
×
論理あて先の定義/変更/削除
×
○
×
×
論理あて先の一覧表示（一覧取得）
○
○
×
○
論理あて先の権限の定義/変更/
削除/一覧表示
×
○
×
×
論理あて先グループ情
報の編集
論理あて先グループの定義/変更/削
除/一覧表示
×
○
×
×
論理あて先の操作
論理あて先の起動/停止
○
×
○
○
論理あて先の出力先（論理デバイス）
切り替え
○
×
○
○
帳票の一覧表示（一覧取得）
○
×
○
○
帳票の出力
○
×
○
○
帳票のプレビュー用データの生成
○
×
×
○
帳票の詳細表示
○
×
×
○
帳票の複写
○
×
○
○
帳票の出力中止
○
×
○
○
帳票の削除
○
×
○
○
帳票の移動
○
×
○
○
帳票の応答待ちへの応答
○
×
○
○
帳票の出力の保留解除
○
×
○
○
帳票の出力の強制中止
○
×
○
○
期限切れ帳票の削除
×
×
○
×
留置き帳票の手元出力用データの生
成
○
×
×
×
帳票の保留解除
○
×
○
×
帳票の出力中止
○
×
○
×
帳票の出力の強制中止
○
×
○
×
帳票の削除
○
×
○
×
帳票の複写
○
×
○
×
論理あて先情報の編集
帳票の操作
論理あて先内の帳票の
一括操作
○：サポート
×：未サポート
- 221 -
付録B 起動オプション
帳票管理アプリケーションを起動する時に、起動オプションのシステムプロパティを指定することで、帳票管理Javaインタフェースの設
定を変更することができます。
ここでは、以下の設定について説明します。
・セキュリティモードの設定
ログインセキュリティの強化を行うかどうかを設定できます。
B.1 セキュリティモードの設定
セキュリティ対策として、セキュリティモードを有効にすることで、ログインセキュリティの強化を行うことができます。
ログインセキュリティを強化すると、ユーザ認証を行ってからログアウトするまでのログイン状態の時のみ、帳票管理Javaインタフェース
を介しての情報の取得や操作が許可されます。ログインしていない状態のときは、情報の取得や操作が許可されずセキュリティ機能が
強化されます。
セキュリティモードを有効にするには、起動オプションのシステムプロパティを設定する必要があります。
以下に、java起動オプションの指定方法、設定値、および記述例について示します。
●java起動オプションの指定方法
javaコマンドの実行時、java起動オプションの-Dオプションで、システムプロパティを指定します。
指定方法は、以下のとおりです。
java -D<name>=<value> -classpath .:/opt/FJSVlstm/classes/f3hxcopr.jar:/opt/FJSVlstm/classes/f3hxcjop.jar Xyz
(*1)
*1：
起動する帳票管理アプリケーションのJavaクラス名を指定します。
●java起動オプションの設定値
java起動オプション（-Dオプション）の<name>にはシステムプロパティ名、<value>にはセキュリティモードを指定します。
詳細は、以下のとおりです。
システムプロパティ名
セキュリティモード
com.fujitsu.listmanager.operate.sec
uritymode
ログインセキュリティの強化を行うかどうかを指定し
ます。
省略値
0
0：ログインセキュリティの強化を行わない
1：ログインセキュリティの強化を行う
●記述例
セキュリティモードを「1」にカスタマイズする場合の記述例を、以下に示します。
java -Dcom.fujitsu.listmanager.operate.securitymode=1 -classpath .:/opt/FJSVlstm/classes/
f3hxcopr.jar:/opt/FJSVlstm/classes/f3hxcjop.jar Xyz
- 222 -
索　引
[A]
add(LMParameterKey key, java.lang.Object value)..............206
add(LMParameterKey key, Object value)..............................206
add(LMParameter param).......................................................207
authorize(java.lang.String userID,java.lang.String password). 23
authorize (java.lang.String userID, java.lang.String password,
LMParametersList loginInfo)...................................................24
getCustomizeItem12().....................................................148,182
getCustomizeItem13().....................................................148,182
getCustomizeItem2()...............................61,84,100,105,145,179
getCustomizeItem3()...............................61,84,100,106,145,180
getCustomizeItem4()...............................62,85,100,106,146,180
getCustomizeItem5()...............................62,85,101,106,146,180
getCustomizeItem6().........................................101,106,146,180
getCustomizeItem7().........................................101,107,146,181
getCustomizeItem8().........................................101,107,147,181
getCustomizeItem9().......................................................147,181
getDataFilename()..................................................................213
getDbPath()...............................................................................97
getDeliverySequenceNo()......................................................129
getDeviceComment()...........................................................59,83
getDeviceName()............................................................59,83,96
getDisplayMessageMode().......................................................98
getDivision()......................................................................98,105
getErrorDetailCode().......................................................137,138
getErrorForms()......................................................................215
getErrorNo()...........................................................................137
getErrorSender().....................................................................137
getErrorStatus()...................................................................62,84
getErrorWatchRange()..............................................................37
getExtension().........................................................................144
getFaxAttributeFileName()......................................................99
getFileName().........................................................................128
getFinished()...........................................................................176
getForm(java.lang.String formID).....................................64,113
getFormFilterCondition().........................................................35
getFormID()..............................................................128,175,212
getForms(FormFilterCondition condition,SortOrder[] sortOrder)
...........................................................................................67,114
getForms(FormFilterCondition condition,SortOrder[]
sortOrder,int resultLimit)...................................................68,115
getForms(FormFilterCondition condition,SortOrder[]
sortOrder,int startPosition,int resultLimit)........................69,118
getForms(java.lang.String
logicalDestination,FormFilterCondition condition,SortOrder[]
sortOrder)................................................................................116
getForms(java.lang.String
logicalDestination,FormFilterCondition condition,SortOrder[]
sortOrder,int resultLimit)........................................................117
getForms(java.lang.String
logicalDestination,FormFilterCondition condition,SortOrder[]
sortOrder,int startPosition,int resultLimit).............................119
getForms(SortOrder[] sortOrder).............................................65
getForms(SortOrder[] sortOrder,int resultLimit).....................66
getFormsCount(FormFilterCondition condition).....................70
getFormsCount(java.lang.String logicalDestination,
FormFilterCondition condition).............................................121
getFormTotalPage()................................................................132
getFullName()......................................................................26,33
getGroupID()............................................................................47
getGroupName().......................................................................48
getHostName()...................................................................96,105
[C]
cancel()...................................................................................159
cancelAllForms(boolean isContinue).......................................73
changeDevice(LogicalDevice device)......................................63
copy(java.lang.String toLogicalDestinationName,boolean
isOutput).................................................................................161
copy(java.lang.String toLogicalDestinationName, boolean
isOutput, LMParametersList printoutOptions).......................163
copyAllForms(java.lang.String
toLogicalDestinationName,boolean isOutput,boolean
isContinue)................................................................................76
copyAllForms(java.lang.String
toLogicalDestinationName,boolean isOutput,boolean
isContinue,LMParametersList printoutOptions)......................77
createOutputData(OutputStream out, LMParametersList
outputOptions)........................................................................169
[D]
delete()....................................................................................161
deleteAllForms(boolean isContinue)........................................75
[F]
forceCancel()..........................................................................160
forceCancelAllForms(boolean isContinue)..............................74
FormFilterCondition()............................................................175
FormFilterConditionクラス......................................................171
FormManager(LMUser user).................................................113
FormManagerクラス................................................................111
Formクラス..............................................................................123
[G]
getActive()................................................................................83
getApplicationServer()...........................................................130
getApplicationType()..............................................................130
getAutoRefreshTime()..............................................................34
getCode()................................................................................210
getComment()..................................26,34,48,58,98,105,133,177
getConnectorSequenceNo()....................................................129
getConnectorSequenceNo2()..................................................129
getConnectorSequenceNo3()..................................................130
getCopy()................................................................................134
getCreateDatetime()................................................................131
getCreateDatetimeFrom().......................................................176
getCreateDatetimeTo()...........................................................176
getCreateUser()................................................................131,176
getCustomizeItem1()...............................61,84,100,105,145,179
getCustomizeItem10().....................................................147,181
getCustomizeItem11().....................................................147,182
- 223 -
getID()......................................................................................48
getItem().................................................................................197
getKeepDays()..........................................................................61
getKeepMode().........................................................................60
getKey()..................................................................................205
getLastViewLD()......................................................................35
getLDFilterCondition().............................................................36
getList()..................................................................................199
getLogicalDestinationName().........................................128,214
getLogicalDestinationNames().................................................52
getLogicalDestinations(LogicalDestinationFilterCondition
condition,SortOrder[] sortOrder)..............................................51
getLogicalDestinations(LogicalDestinationFilterCondition
condition,SortOrder[] sortOrder,int startPosition,int resultLimit)
..................................................................................................53
getLogicalDestinations(SortOrder[] sortOrder).......................51
getLogicalDestinationsCount(LogicalDestinationFilterConditio
n condition)...............................................................................54
getLogicalDevices(LogicalDeviceFilterCondition
condition,SortOrder[] sortOrder)..............................................92
getLogicalDevices(SortOrder[] sortOrder)...............................91
getMaxForms().........................................................................36
getMimeType().......................................................................145
getName()..................................................58,82,95,104,132,177
getOperatorIdInfo()................................................................178
getOrder()...............................................................................197
getOutputFolder().....................................................................97
getOutputMethod()..................................................59,83,96,104
getOutputMode()......................................................................60
getOutputStatus().............................................................134,178
getPaperCode().......................................................................134
getParameterAt(int index)......................................................207
getParameterAt(LMParameterKey key).................................207
getParameterKey(int index)....................................................208
getParameterValue (int index)................................................208
getParameterValue(LMParameterKey key)...........................208
getPdfAttributeFileName().......................................................99
getPositionType().....................................................................97
getPositionX()...........................................................................98
getPositionY()...........................................................................97
getPreviewCount()..................................................................136
getPrintedPage().....................................................................132
getPrintoutCount()..................................................................136
getPrintoutDatetime().............................................................135
getPrintoutDatetimeFrom()....................................................179
getPrintoutDatetimeTo().........................................................179
getPrintoutUserID().........................................................135,178
getPriority().........................................................................59,82
getRequestClient()...........................................................130,175
getResultCount().....................................................................200
getSaveLimitDate()................................................................134
getSaveLimitDateFrom()........................................................178
getSaveLimitDateTo()............................................................178
getSendMessageHostName()....................................................99
getSuccessNumber()...............................................................215
getSurname()............................................................................34
getTitle()..........................................................................132,177
getTotalNumber()...................................................................214
getTotalPage()........................................................................131
getType().............................................................................58,82
getUserGroupID().....................................................................27
getUserGroupNames(java.lang.String[] groupIDs, SortOrder[]
sortOrder)..................................................................................28
getUserGroups(java.lang.String groupID,SortOrder[] sortOrder)
..................................................................................................46
getUserGroups(SortOrder[] sortOrder)....................................45
getUserID()..........................................................................26,33
getUserInfo()............................................................................27
getUserNames(java.lang.String[] userIDs, SortOrder[]
sortOrder)..................................................................................27
getUsers(java.lang.String userID,java.lang.String
groupID,SortOrder[] sortOrder)...............................................44
getUsers(SortOrder[] sortOrder)...............................................43
getValue()...............................................................................205
[H]
hasMoreResult().....................................................................199
[I]
isActive()..................................................................................60
isAutoRefresh()........................................................................34
isDisplayErrorMessage()..........................................................37
isFinished().............................................................................131
isKeepForm()..........................................................................133
isOutputForm().......................................................................133
isSaveFormFilterCondition()....................................................35
isSaveLDFilterCondition().......................................................36
[L]
LMNameクラス.........................................................................48
LMParameter().......................................................................203
LMParameter(LMParameterKey key, java.lang.Object value)
................................................................................................203
LMParameterKeyクラス..........................................................200
LMParametersList()................................................................206
LMParametersListクラス.........................................................205
LMParameterクラス.................................................................202
LMUserGroupクラス.................................................................47
LMUserInfoクラス.....................................................................31
LMUserManagerクラス.............................................................42
LMUserクラス...........................................................................25
LogicalDestinationFilterCondition()........................................82
LogicalDestinationFilterConditionクラス..................................79
LogicalDestinationManager(LMUser user).............................50
LogicalDestinationManagerクラス............................................49
LogicalDestinationクラス..........................................................55
LogicalDeviceFilterCondition().............................................104
LogicalDeviceFilterConditionクラス.......................................101
LogicalDeviceManager()..........................................................90
LogicalDeviceManager(LMUser user).....................................91
LogicalDeviceManagerクラス...................................................90
LogicalDeviceクラス.................................................................93
logout(LMParametersList logoutInfo).....................................29
- 224 -
[M]
move(java.lang.String toLogicalDestinationName,boolean
isOutput).................................................................................165
move(java.lang.String toLogicalDestinationName,boolean
isOutput,LMParametersList printoutOptions)........................167
setCustomizeItem5(java.lang.String customizeItem5).....
89,110,189
setCustomizeItem6(java.lang.String customizeItem6)....110,190
setCustomizeItem7(java.lang.String customizeItem7)....111,190
setCustomizeItem8(java.lang.String customizeItem8)....111,190
setCustomizeItem9(java.lang.String customizeItem9)...........190
setDeviceComment(java.lang.String deviceComment)...........87
setDeviceName(java.lang.String deviceName)........................86
setDivision(java.lang.String division)....................................109
setErrorStatus(int errorStatus)..................................................88
setFinished(java.lang.Boolean finished).................................184
setFormID(java.lang.String formID)......................................182
setHostName(java.lang.String hostName).............................108
setKey(LMParameterKey key)...............................................204
setName(java.lang.String name).................................85,107,184
setOperatorIdInfo(java.lang.String[] operatorIdInfo).............186
setOrder(int order)..................................................................198
setOutputMethod(int[] outputMethod)..............................87,107
setOutputStatus(int[] outputStatus)........................................186
setPrintoutDatetime(java.util.Date from,java.util.Date to).....187
setPrintoutUserID(java.lang.String printoutUserID)..............187
setPriority(int priority)..............................................................86
setRequestClient(java.lang.String requestClient)...................182
setSaveLimitDate(java.util.Date from,java.util.Date to)........185
setTitle(java.lang.String title).................................................185
setType(int type).......................................................................85
setValue(java.lang.Object value)............................................204
size().......................................................................................209
SortOrder(int item).................................................................197
SortOrder(int item,int order)...................................................197
SortOrderクラス.......................................................................192
start().........................................................................................62
stop().........................................................................................63
Symfoware..................................................................................9
[O]
OperateAllFormsException(java.lang.String message,int
code,java.lang.String logicalDestination,int totalNumber,int
successNumber,OperateFormException[] errorForms)..........214
OperateAllFormsExceptionクラス...........................................213
OperateException(java.lang.String message,int code)...........210
OperateExceptionクラス..........................................................209
OperateFormException(java.lang.String message,int
code,java.lang.String formID,java.lang.String filename).......212
OperateFormExceptionクラス.................................................211
Oracle........................................................................................11
[P]
preview(int contentType,int startPage,int
endPage,java.io.OutputStream out)........................................153
preview(int contentType,java.io.OutputStream out)..............151
preview(int startPage,int endPage,java.io.OutputStream out)155
preview(java.io.OutputStream out)........................................154
preview(OutputStream out, LMParametersList outputOptions)
................................................................................................157
printout(int startPage,int endPage,int copy)...........................148
printout(int startPage, int endPage, int copy, LMParametersList
printoutOptions)......................................................................150
printStackTrace()....................................................................210
printStackTrace(java.io.PrintStream s)...................................211
printStackTrace(java.io.PrintWriter s)...................................211
[R]
responseError().......................................................................160
resumeAllForms(boolean isContinue)......................................71
resumeAllForms(boolean isContinue,LMParametersList
printoutOptions)........................................................................72
reverseOrder().........................................................................198
[U]
update(java.lang.String formID, LMParametersList
updateItems)...........................................................................121
updateAutoRefresh(boolean autoRefresh,int time)..................37
updateDisplayErrorMessage(boolean display, java.lang.String[]
logicalDestinationNames)........................................................41
updateFormFilterCondition(boolean save,FormFilterCondition
condition)..................................................................................38
updateLDFilterCondition(boolean
save,LogicalDestinationFilterCondition condition).................39
updateMaxForms(int forms).....................................................41
UserAuthorizationクラス...........................................................23
[S]
setActive(java.lang.Boolean active).........................................87
setComment(java.lang.String comment).........................108,185
setCreateDatetime(java.util.Date from,java.util.Date to).......183
setCreateUser(java.lang.String createUser)............................183
setCustomizeItem1(java.lang.String customizeItem1).....
88,109,188
setCustomizeItem10(java.lang.String customizeItem10).......191
setCustomizeItem11(java.lang.String customizeItem11).......191
setCustomizeItem12(java.lang.String customizeItem12).......191
setCustomizeItem13(java.lang.String customizeItem13).......192
setCustomizeItem2(java.lang.String customizeItem2).....
88,109,188
setCustomizeItem3(java.lang.String customizeItem3).....
89,109,189
setCustomizeItem4(java.lang.String customizeItem4).....
89,110,189
[あ]
インタフェースサポート範囲...................................................220
[か]
開発環境....................................................................................9
環境変数の設定（List Manager管理データベースがOracleの場
合）............................................................................................11
環境変数の設定（List Manager管理データベースがSymfoware
の場合）......................................................................................9
記述例......................................................................................15
- 225 -
起動オプション.......................................................................222
機能概要....................................................................................1
クラス一覧.................................................................................21
クラスの詳細（ソート指定）......................................................192
クラスの詳細（帳票関連）.......................................................111
クラスの詳細（ユーザ関連）.....................................................22
クラスの詳細（例外）...............................................................209
クラスの詳細（論理あて先関連）..............................................49
クラスの詳細（論理デバイス関連）...........................................90
クラスの詳細（パラメータ関連）..............................................200
コンパイル・実行.......................................................................20
論理あて先の取得/検索を行うクラス.......................................49
論理デバイス情報......................................................................5
論理デバイス情報を取得するクラス........................................93
論理デバイスの検索条件を指定するクラス..........................101
論理デバイスの取得/検索を行うクラス....................................90
[さ]
作成手順..................................................................................15
指定できる情報..........................................................................3
指定できる文字........................................................................20
セキュリティモードの設定.......................................................222
ソート項目を指定するクラス...................................................192
[た]
帳票管理Javaインタフェース.....................................................9
帳票管理Javaインタフェースで指定できる文字......................20
帳票管理アプリケーション機能とは...........................................1
帳票管理アプリケーション機能を使用してできること...............2
帳票管理アプリケーション実行時に設定する環境変数..........9
帳票管理アプリケーションの開発............................................15
帳票管理Javaインタフェースのサポート範囲........................220
帳票属性....................................................................................5
帳票属性の更新を行うクラス.................................................111
帳票属性の取得を行うクラス.................................................123
帳票に対する操作を行うクラス..............................................123
帳票の検索条件を指定するクラス........................................171
帳票の検索を行うクラス....................................................55,111
帳票の出力状態と帳票の操作の関係......................................6
帳票の取得を行うクラス....................................................55,111
提供する機能.............................................................................2
動作環境....................................................................................1
[は]
パッケージ名..............................................................................9
[ま]
モジュール構成..........................................................................9
[や]
ユーザグループ情報.................................................................4
ユーザグループ情報を取得するクラス...................................47
ユーザごとの帳票管理情報......................................................3
ユーザ情報.................................................................................3
ユーザに関する基本情報を取得するクラス............................25
ユーザ認証を行うクラス...........................................................23
ユーザを管理するクラス...........................................................42
[ら]
例外クラス...............................................................................209
論理あて先情報.........................................................................4
論理あて先情報の取得を行うクラス........................................55
論理あて先に対する操作を行うクラス.....................................55
論理あて先の検索条件を指定するクラス...............................79
- 226 -

Download Report