AccountInfoManagerオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.15 |
since | 8.0.0 |
アカウントマネージャクラス。
アカウント情報の操作を行います。
AccountInfoManager では、アカウント情報の追加・更新時にパスワード利用可能文字のチェックを行いません。
パスワード利用可能文字のチェックは、PasswordHistoryManager を利用してください。
version 8.0.13 以降、以下のメソッドの挙動に変更があります。詳細は各メソッドの説明を参照してください。
アカウントのパスワードが登録・更新したものを同一であるかを判断する場合は、 AccountPasswordAdapter を利用してください。
アカウント情報の操作を行います。
パスワード利用可能文字のチェックに関して
AccountInfoManager では、アカウント情報の追加・更新時にパスワード利用可能文字のチェックを行いません。
パスワード利用可能文字のチェックは、PasswordHistoryManager を利用してください。
バージョンによる挙動の変更について
version 8.0.13 以降、以下のメソッドの挙動に変更があります。詳細は各メソッドの説明を参照してください。
- getAccountInfo(String)
- getAccountInfos()
- getAccountInfos(Number, Number)
- getAccountInfosByUserCds(Array)
- searchAccountInfos(String)
- searchAccountInfos(String, Number, Number)
- updateAccountInfo(AccountInfo)
アカウントのパスワードが登録・更新したものを同一であるかを判断する場合は、 AccountPasswordAdapter を利用してください。
定数
型 | 定数名 | 定数値 |
---|---|---|
Stringstatic | ATTR_DECIMAL_FORMAT アカウント属性として格納される数値形式の属性名です。 この定数は バージョン 8.0.15 より利用可能です。 |
"im_i18n_decimal_format_id" |
コンストラクタの概要
AccountInfoManager () コンストラクタ。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | addAccountInfo (AccountInfo accountInfo ) アカウント情報を新規追加します。 |
ResultObject | addAccountRoleInfo (String userCd , AccountRoleInfo accountRoleInfo ) 指定されたユーザのアカウント付与ロール情報を新規追加します。 |
ResultObject | contains (String userCd ) 指定されたユーザが登録されているかチェックします。 |
ResultObject | deleteAccountInfo (String userCd ) 指定されたユーザのアカウント情報を削除します。 |
ResultObject | deleteAccountInfos () すべてのアカウント情報を削除します。 |
ResultObject | deleteAccountRoleInfo (String userCd , String roleId ) 指定されたユーザのアカウント付与ロール情報を削除します。 |
ResultObject | deleteAccountRoleInfos (String userCd ) 指定されたユーザのすべてのアカウント付与ロール情報を削除します。 |
ResultObject | deleteAttribute (String userCd , String name ) 指定されたユーザのアカウント属性情報を削除します。 |
ResultObject | deleteAttributes (String userCd ) 指定されたユーザのすべてのアカウント属性情報を削除します。 |
ResultObject | getAccountInfoCount () 登録されているアカウント数を取得します。 |
ResultObject | getAccountInfo (String userCd ) 指定されたユーザのアカウント情報を取得します。 |
ResultObject | getAccountInfosByUserCds (Array userCds ) 指定されたユーザのアカウント情報を取得します。 |
ResultObject | getAccountInfos (Number start , Number count ) 指定された件数のアカウント情報を取得します。 |
ResultObject | getAccountInfos () すべてのアカウント情報を取得します。 |
ResultObject | getAccountRoleIdsRecursively (String userCd , Date date ) 指定されたユーザの有効なアカウント付与ロールのロールIDを取得します。 |
ResultObject | getAccountRoleIds (String userCd , Date date ) 指定されたユーザの有効なアカウント付与ロールのロールIDを取得します。 |
ResultObject | getAccountRoleIds (String userCd ) 指定されたユーザのアカウント付与ロールのロールIDを取得します。 |
ResultObject | getAccountRoleInfos (String userCd , Date date ) 指定されたユーザの有効なアカウント付与ロール情報を取得します。 |
ResultObject | getAccountRoleInfos (String userCd ) 指定されたユーザのすべてアカウント付与ロール情報を取得します。 |
ResultObject | getAttributeNames (String userCd ) 指定されたユーザのアカウント属性名を取得します。 |
ResultObject | getAttribute (String userCd , String name , String def ) 指定されたユーザのアカウント属性値を取得します。 |
ResultObject | getAttribute (String userCd , String name ) 指定されたユーザのアカウント属性値を取得します。 |
ResultObject | getUserCdsByAccountRoleId (String roleId ) 指定されたアカウント付与ロールを持つアカウントのユーザコードを取得します。 |
ResultObject | getUserCdsByAttribute (String key , String value ) 指定されたアカウント属性情報を持つ全てのユーザコードを取得します。 |
ResultObject | getUserCdsByRoleId (String roleId , Date date ) 有効なロールIDを持つすべてのユーザコードを取得します。 |
ResultObject | getUserCds () すべてのユーザコードを取得します。 |
ResultObject | isUpdate (Date date ) 非推奨アカウント情報が指定された日付以降に更新されているかチェックします。
8.0.4 以降では、更新チェックを行わなくなりました。このメソッドは常に
true を返します。
|
ResultObject | searchAccountInfos (String userCd , Number start , Number count ) 指定された検索文字列にマッチするユーザコードを持つアカウント情報を返却します。 |
ResultObject | searchAccountInfos (String userCd ) 指定された検索文字列にマッチするユーザコードを持つアカウント情報を返却します。 |
ResultObject | setAttribute (String userCd , String name , String value ) アカウント属性を設定します。 |
ResultObject | updateAccountInfo (AccountInfo accountInfo ) アカウント情報を更新します。 |
ResultObject | updateAccountRoleInfo (String userCd , AccountRoleInfo accountRoleInfo ) 指定されたユーザのアカウント付与ロール情報を更新します。 |
コンストラクタの詳細
AccountInfoManager ()
コンストラクタ。
|
メソッドの詳細
ResultObject addAccountInfo (AccountInfo accountInfo )
アカウント情報を新規追加します。
パラメータ
返却値
|
ResultObject addAccountRoleInfo (String userCd , AccountRoleInfo accountRoleInfo )
指定されたユーザのアカウント付与ロール情報を新規追加します。
パラメータ
返却値
|
ResultObject contains (String userCd )
指定されたユーザが登録されているかチェックします。
パラメータ
返却値
|
ResultObject deleteAccountInfo (String userCd )
指定されたユーザのアカウント情報を削除します。
パラメータ
返却値
|
ResultObject deleteAccountInfos ()
すべてのアカウント情報を削除します。
返却値
|
ResultObject deleteAccountRoleInfo (String userCd , String roleId )
指定されたユーザのアカウント付与ロール情報を削除します。
パラメータ
返却値
|
ResultObject deleteAccountRoleInfos (String userCd )
指定されたユーザのすべてのアカウント付与ロール情報を削除します。
パラメータ
返却値
|
ResultObject deleteAttribute (String userCd , String name )
指定されたユーザのアカウント属性情報を削除します。
パラメータ
返却値
|
ResultObject deleteAttributes (String userCd )
指定されたユーザのすべてのアカウント属性情報を削除します。
パラメータ
返却値
|
ResultObject getAccountInfoCount ()
登録されているアカウント数を取得します。
返却値
|
ResultObject getAccountInfo (String userCd )
指定されたユーザのアカウント情報を取得します。
パスワード保存方式に「ハッシュ化」を利用している場合、AccountInfo のパスワード値は null となります。
パラメータ
返却値
|
ResultObject getAccountInfosByUserCds (Array userCds )
指定されたユーザのアカウント情報を取得します。
パスワード保存方式に「ハッシュ化」を利用している場合、AccountInfo のパスワード値は null となります。
パラメータ
返却値
|
ResultObject getAccountInfos (Number start , Number count )
指定された件数のアカウント情報を取得します。
パスワード保存方式に「ハッシュ化」を利用している場合、AccountInfo のパスワード値は null となります。
パラメータ
返却値
|
ResultObject getAccountInfos ()
すべてのアカウント情報を取得します。
パスワード保存方式に「ハッシュ化」を利用している場合、AccountInfo のパスワード値は null となります。
返却値
|
ResultObject getAccountRoleIdsRecursively (String userCd , Date date )
指定されたユーザの有効なアカウント付与ロールのロールIDを取得します。
一覧には、有効なアカウント付与ロールのすべてのサブロールが含まれます。 有効期限判定は以下の通りです。
パラメータ
返却値
|
ResultObject getAccountRoleIds (String userCd , Date date )
指定されたユーザの有効なアカウント付与ロールのロールIDを取得します。
有効期限判定は以下の通りです。
パラメータ
返却値
|
ResultObject getAccountRoleIds (String userCd )
指定されたユーザのアカウント付与ロールのロールIDを取得します。
パラメータ
返却値
|
ResultObject getAccountRoleInfos (String userCd , Date date )
指定されたユーザの有効なアカウント付与ロール情報を取得します。
有効期限判定は以下の通りです。
パラメータ
返却値
|
ResultObject getAccountRoleInfos (String userCd )
指定されたユーザのすべてアカウント付与ロール情報を取得します。
パラメータ
返却値
|
ResultObject getAttributeNames (String userCd )
指定されたユーザのアカウント属性名を取得します。
パラメータ
返却値
|
ResultObject getAttribute (String userCd , String name , String def )
指定されたユーザのアカウント属性値を取得します。
パラメータ
返却値
|
ResultObject getAttribute (String userCd , String name )
指定されたユーザのアカウント属性値を取得します。
パラメータ
返却値
|
ResultObject getUserCdsByAccountRoleId (String roleId )
指定されたアカウント付与ロールを持つアカウントのユーザコードを取得します。
指定したアカウント付与ロールの階層のチェックは行いません。
パラメータ
返却値
|
ResultObject getUserCdsByAttribute (String key , String value )
指定されたアカウント属性情報を持つ全てのユーザコードを取得します。
パラメータ
返却値
|
ResultObject getUserCdsByRoleId (String roleId , Date date )
有効なロールIDを持つすべてのユーザコードを取得します。
指定したロールIDからすべての親ロールを取得し、 指定日付で有効なアカウント付与ロールを持つアカウントのユーザコード一覧を返却します。
パラメータ
返却値
|
ResultObject getUserCds ()
すべてのユーザコードを取得します。
返却値
|
ResultObject isUpdate (Date date )
非推奨
8.0.4 以降では、更新チェックを行わなくなりました。このメソッドは常に
true を返します。
アカウント情報が指定された日付以降に更新されているかチェックします。
パラメータ
返却値
|
ResultObject searchAccountInfos (String userCd , Number start , Number count )
指定された検索文字列にマッチするユーザコードを持つアカウント情報を返却します。
以下の文字を特殊文字として扱います。 * 0 以上の長さの文字列とマッチ? 1 文字の文字列とマッチパスワード保存方式に「ハッシュ化」を利用している場合、AccountInfo のパスワード値は null となります。
パラメータ
返却値
|
ResultObject searchAccountInfos (String userCd )
指定された検索文字列にマッチするユーザコードを持つアカウント情報を返却します。
以下の文字を特殊文字として扱います。 * 0 以上の長さの文字列とマッチ? 1 文字の文字列とマッチパスワード保存方式に「ハッシュ化」を利用している場合、AccountInfo のパスワード値は null となります。
パラメータ
返却値
|
ResultObject setAttribute (String userCd , String name , String value )
アカウント属性を設定します。
引数で指定した属性名に一致する属性情報が存在しない場合は、新規に登録します。 引数で指定した属性名に一致する属性情報がすでに存在する場合は、指定された属性値で更新します。 引数のユーザコード、属性名、属性値には null または、空文字を許容しません。
パラメータ
返却値
|
ResultObject updateAccountInfo (AccountInfo accountInfo )
アカウント情報を更新します。
アカウント情報(AccountInfo)のパスワード値がnullである場合はパスワード値以外の値を更新します。
パラメータ
返却値
|
ResultObject updateAccountRoleInfo (String userCd , AccountRoleInfo accountRoleInfo )
指定されたユーザのアカウント付与ロール情報を更新します。
パラメータ
返却値
|