論理あて先を意識せずに、帳票の取得/検索や帳票属性の更新を行うクラスです。
論理あて先の表示権限を持たなくても、すべての論理あて先を対象にして、帳票を取得/検索することができます。
特定の論理あて先内の帳票だけを扱う場合は、その論理あて先名を引数に指定して検索します。帳票の検索条件は、FormFilterConditionクラスを使用して指定します。
java.lang.Object
└com.fujitsu.listmanager.operate.FormManager
public class FormManager
extends java.lang.Objectポイント
検索条件には、ワイルドカード文字として「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することができます。ワイルドカード文字を指定した場合に、検索条件に「パーセント（%）」または「アンダースコア（_）」が含まれていると、正しく絞り込みが行われない場合があります。
検索条件に空白を指定しないでください。空白を指定すると、正しく絞り込みが行われません。また、検索条件に空白を指定して、空白が設定されている情報を絞り込むことはできません。
FormManagerクラスのコンストラクタを以下に示します。
コンストラクタの概要 |
|---|
|
FormManagerクラスのメソッドを以下に示します。
ポイント
各帳票属性の定義については、オンラインマニュアル“帳票印刷配信機能 セットアップガイド”を参照してください。
用途
FormManagerクラスのFormManagerオブジェクトを生成します。
パラメータ
UserAuthorizationクラス、またはLMUserManagerクラスで取得したユーザを指定します。
例外
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
|
用途
帳票IDを指定して、帳票を取得します。
パラメータ
取得する帳票の帳票IDを指定します。
帳票IDの一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することはできません。
戻り値
帳票
なお、該当する帳票がない場合は、「null」が取得されます。
例外
取得処理でエラーが発生した場合
帳票IDが「null」の場合
帳票IDに「クエスチョンマーク（?）」または「アスタリスク（*）」が含まれている場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
|
用途
帳票の絞り込み条件を指定して、帳票を取得します。
パラメータ
帳票を絞り込んで検索するときの条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
条件に一致した帳票の配列
なお、条件に一致する帳票がない場合は、長さ0の配列が取得されます。
例外
取得処理でエラーが発生した場合
指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
|
用途
帳票の絞り込み条件、および最大取得件数を指定して、帳票を取得します。
最大取得件数は、取得する帳票の最大数です。
取得した帳票は、ListResultクラスのgetListメソッドで取得します。getListメソッドの戻り値を、帳票の配列Form[]にキャストして取得します。
パラメータ
帳票を絞り込んで検索するときの条件を指定します。
の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
帳票の最大取得件数を指定します。
「0」以下の値を指定した場合は無制限となります。
戻り値
一覧で取得した結果
例外
取得処理でエラーが発生した場合
指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
|
用途
検索対象にする論理あて先名、および帳票の絞り込み条件を指定して、帳票を取得します。
パラメータ
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
すべての論理あて先を検索対象にする場合は、「null」を指定します。
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
戻り値
帳票の一覧
例外
取得処理でエラーが発生した場合
指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6 個以上指定した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/ 検索した論理あて先名）が更新される場合があります。
詳細については、以下を参照してください。
⇒“3.6.3 LMUserInfoクラス”のgetLastViewLD()”
用途
検索対象にする論理あて先名、帳票の絞り込み条件、および最大取得件数を指定して、帳票を取得します。
最大取得件数は、取得する帳票の最大数です。
取得した帳票は、ListResultクラスのgetListメソッドで取得します。getListメソッドの戻り値を、帳票の配列Form[]にキャストして取得します。
パラメータ
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
すべての論理あて先を検索対象にする場合は、「null」を指定します。
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。例えば、ソート項目を2個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
帳票の最大取得件数を指定します。
「0」以下の値を指定した場合は無制限となります。
戻り値
一覧で取得した結果
例外
取得処理でエラーが発生した場合
指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
このメソッドで帳票を取得すると、LMUserInfoクラスのgetLastViewLDメソッドで取得できる値（ユーザが最後に帳票を取得/ 検索した論理あて先名）が更新される場合があります。
詳細については、以下を参照してください。
⇒“3.6.3 LMUserInfoクラス”のgetLastViewLD()”
|
用途
帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して、部分的な帳票の一覧を取得します。
最大取得件数は取得する帳票の最大数です。
帳票を取得した結果は、ListResult クラスのgetList メソッドの戻り値をForm[] にキャストして取得します。
パラメータ
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目名は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
部分取得する際の取得開始位置を指定します。
「0」以下を指定した場合は先頭から取得します（「1」を指定した場合と同じです）。
帳票一覧取得時に指定する絞り込み条件（condition）に一致する帳票の件数より大きい値を指定した場合は取得件数が0件になります。
最大取得件数を指定します。
「0」以下を指定した場合は無制限に取得します。
帳票一覧取得時に指定する絞り込み条件（condition）に一致する帳票の件数より大きい値を指定した場合は、絞り込み条件に一致する件数分だけ取得し、例外は発生しません。
戻り値
一覧で取得した結果
例外
取得処理でエラーが発生した場合
指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
用途
論理あて先、帳票の絞り込み条件、取得開始位置、および最大取得件数を指定して帳票を取得します。
最大取得件数は取得する帳票の最大数です。
帳票を取得した結果は、ListResult クラスのgetList メソッドの戻り値をForm[] にキャストして取得します。
パラメータ
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
「null」を指定した場合はすべての論理あて先を検索対象にします。
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
取得した帳票をソートする場合、並べ替えのキーにするソート項目を指定します。
ソート項目名は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。
例えば、ソート項目を2 個指定した場合、最初に指定したソート項目でソートが行われたあと、ソートされた範囲内で、2 番目に指定したソート項目でソートが行われます。
「null」を指定した場合、List Manager 管理データベースで管理されている順になり、ソートはされません。
ソート項目の詳細については、以下を参照してください。
⇒“3.10.1 SortOrderクラス”
部分取得する際の取得開始位置を指定します。
「0」以下を指定した場合は先頭から取得します（「1」を指定した場合と同じです）。
帳票一覧取得時に指定する絞り込み条件（logicalDestination, condition）に一致する帳票の件数より大きい値を指定した場合は取得件数が0件になります。
最大取得件数を指定します。
「0」以下を指定した場合は無制限に取得します。
帳票一覧取得時に指定する絞り込み条件（logicalDestination, condition）に一致する帳票の件数より大きい値を指定した場合は、絞り込み条件に一致する件数分だけ取得し、例外は発生しません。
戻り値
一覧で取得した結果
例外
取得処理でエラーが発生した場合
指定できないソート項目がある場合
同じソート項目を複数指定した場合
ソート項目を6個以上指定した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
備考
このメソッドで帳票を取得すると、LMUserInfo クラスのgetLastViewLD メソッドで取得できる値（ユーザが最後に帳票を取得/ 検索した論理あて先名）が更新される場合があります。
詳細については、以下を参照してください。
⇒“3.6.3 LMUserInfoクラス”のgetLastViewLD()”
|
用途
論理あて先、帳票の絞り込み条件を指定して、指定した条件に一致する帳票の総件数を取得します。
パラメータ
検索対象にする論理あて先名を指定します。
論理あて先名の一部に、ワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定することもできます。
「null」を指定した場合はすべての論理あて先を検索対象にします。
帳票の絞り込み条件を指定します。
帳票の絞り込み条件については、以下を参照してください。
⇒“3.9.3 FormFilterConditionクラス”
この条件で絞り込みを行わない場合は、「null」を指定します。
戻り値
指定した条件に一致する帳票の総件数
例外
取得処理でエラーが発生した場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
|
用途
List Manager 管理データベースに管理されている帳票のカスタマイズ項目、業務あて先を更新します。
パラメータ
更新対象とする帳票の帳票IDを指定します。
更新対象とするカスタマイズ項目、業務あて先を、LMParameterKeyクラスの以下のフィールドを使用して、Stringオブジェクトで指定することができます。
指定できるキーのフィールド名 | 更新対象の帳票属性 |
|---|---|
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 | 業務あて先 |
例外
更新処理でエラーが発生した場合
帳票IDの値として、「null」が指定された場合
updateItemsパラメータとして、「null」が指定された場合
カスタマイズ項目、業務あて先の値として、Stringオブジェクト以外が指定された場合
updateItemsパラメータの各キーに「null」が指定された場合
updateItemsパラメータのキーとしてカスタマイズ項目、業務あて先のいずれも指定しなかった場合
セキュリティモード有効時において、ユーザがログイン状態ではない場合
セキュリティモードについては、以下を参照してください。
⇒“B.1 セキュリティモードの設定”
注意
業務あて先の指定方法は、帳票登録時に指定した形式と同じ形式で指定してください。
更新する値を何も指定せずに更新した場合、更新後に帳票情報を再度取得し、更新した項目をFormクラスから取り出すと「null」を取得します。
備考
更新する値を空にしたい場合は値を何も指定せずに更新します。
updateItemsパラメータに指定されたキー以外の項目は更新されません。
帳票属性を更新するには、更新対象の帳票が存在する論理あて先に対して操作権限が必要です。ただし、論理あて先の権限がない場合でも、更新対象とする帳票の作成ユーザであれば更新できます。
更新処理が正常終了した場合でも取得済みの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 |