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

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を取得します。
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」が取得されます。

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：

取得したユーザ名（フルネーム）をソートする場合、並べ替えのキーにするソート項目を指定します。

ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。

例えば、ソート項目を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条件）になります。

ユーザグループ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

用途

ログアウトを行います。
このメソッドを使用するには、セキュリティモードの設定を、「ログインセキュリティの強化を行う」設定にする必要があります。

セキュリティモードについては、以下を参照してください。
⇒“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メソッド
  	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 クラスの生成が実行された場合には、例外が発生します。