Interstage List Works for Modernization V11.0.0 帳票印刷配信機能アプリケーション作成ガイド 帳票管理編

3.6.3 LMUserInfoクラス

ユーザごとの帳票管理情報を取得/変更するためのクラスです。

LMUserクラスのメソッドから取得されます。

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


public class LMUserInfo
extends java.lang.Object

注意

• 一般ユーザが自分以外のユーザのユーザごとの帳票管理情報を取得する場合、List Managerの管理者権限が必要です。

• このクラスのメソッドで以下の値を変更した場合、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() 応答メッセージを表示させる論理あて先名を取得します。
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()

用途

ユーザのフルネームを取得します。

戻り値

フルネーム

public java.lang.String

getSurname()

用途

ユーザの姓を取得します。

戻り値

姓

public java lang.String

getComment()

用途

ユーザのコメントを取得します。

戻り値

コメント

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

public boolean

isAutoRefresh()

用途

取得した帳票一覧を自動更新するかどうかの設定を取得します。

戻り値

true：

自動更新する設定の場合

false：

自動更新しない設定の場合

public int

getAutoRefreshTime()

用途

取得した帳票一覧の自動更新間隔の値を取得します。

戻り値

自動更新間隔（秒）

public java.lang.String

getLastViewLD()

用途

ユーザが最後に帳票を取得/検索した論理あて先名を取得します。

戻り値

論理あて先名

なお、ユーザが一度も帳票を取得していない場合は、「null」が取得されます。

備考

• ユーザが最後に帳票を取得/検索した論理あて先名は、以下の処理を行った場合に、帳票管理Javaインタフェースが自動的に設定します。

  • LogicalDestinationクラスのgetFormメソッドまたはgetFormsメソッドで、帳票を取得した場合
    帳票の取得時に、条件に一致する帳票がなかった場合でも、設定値が更新されます。

  • FormManagerクラスのgetFormsメソッドで、論理あて先名を指定して帳票を取得した場合
    ただし、以下の場合、設定値は更新されません。

    • 帳票の取得時に条件に一致する帳票がなかった場合

    • 論理あて先名にnullを指定した場合

    • 論理あて先名の一部にワイルドカード文字「クエスチョンマーク（?）」または「アスタリスク（*）」を指定した場合

  • 操作画面の帳票一覧画面を表示した場合
    ただし、論理あて先内に帳票がなかった場合、設定値は更新されません。

public boolean

isSaveFormFilterCondition()

用途

帳票の絞り込み条件を保存するかどうかの設定値を取得します。

戻り値

true：

帳票の絞り込み条件を保存する設定の場合

false：

帳票の絞り込み条件を保存しない設定の場合

備考

• List Manager管理データベースにユーザごとに管理されている値が取得されます。

public FormFilterCondition

getFormFilterCondition()

用途

帳票の絞り込み条件を取得します。

戻り値

帳票の絞り込み条件

なお、帳票の絞り込み条件が指定されていない場合は、条件が何も指定されていないFormFilterConditionクラスが取得されます。

備考

• List Manager管理データベースにユーザごとに管理されている値が取得されます。

public boolean

isSaveLDFilterCondition()

用途

論理あて先の絞り込み条件を保存するかどうかの設定を取得します。

戻り値

true：

論理あて先の絞り込み条件を保存する設定の場合

false：

論理あて先の絞り込み条件を保存しない設定の場合

備考

• List Manager管理データベースにユーザごとに管理されている値が取得されます。

public LogicalDestinationFilterCondition

getLDFilterCondition()

用途

論理あて先の絞り込み条件を取得します。

戻り値

論理あて先の絞り込み条件

なお、論理あて先の絞り込み条件が指定されていない場合は、条件が何も指定されていないLogicalDestinationFilterConditionクラスが取得されます。

備考

• List Manager管理データベースにユーザごとに管理されている値が取得されます。

public int

getMaxForms()

用途

帳票を一覧取得する場合の最大取得帳票数の設定値を取得します。

最大取得帳票数は、帳票を一覧取得する場合の帳票の最大数です。

戻り値

最大取得帳票数

備考

• 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

用途

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

用途

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)

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管理データベースに保存できます。

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：

応答メッセージを表示する場合に指定します。

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インタフェースの各クラスのメソッドの値や動作が変更されることはありません。