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

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

注意

このクラスのメソッドを使用して、ユーザ/ユーザグループを取得するには、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：

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

ソート項目は複数指定できます。複数指定した場合、最初に指定したソート項目がもっとも優先度が高くなり、それ以降は順に優先度が低くなります。例えば、ソート項目を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」を指定します。

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クラス”

戻り値

すべてのユーザグループの配列

なお、ユーザグループが存在しない場合は、長さ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：

• 指定できないソート項目がある場合

• 同じソート項目を複数指定した場合

• ソート項目を6個以上指定した場合

java.lang.Illegal StateException：

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

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