スクリプト開発向けim-BizAPI (互換)

AccountManagerオブジェクト非推奨

AccountInfoManager を利用してください。
コンポーネント情報
version2.0
since2.0
コンポーネント概要
アカウントマネージャオブジェクト
アカウント情報の参照、更新を行うマネージャオブジェクトです。

定数

型 定数名 定数値
Stringstatic ATTR_MENU_DISPLAY
ユーザ属性名: ログイン時のメニュー表示・非表示用。 		"im_menu_display"
Stringstatic ATTR_MENU_FOLDER_DISPLAY_METHOD
ユーザ属性名: メニューフォルダの表示方法。 		"im_menu_folder_display_method"
Stringstatic ATTR_MOBILE_EASY_LOGIN
ユーザ属性名: かんたんログイン用。 		"im_mobile_easy_login"
Stringstatic ATTR_MOBILE_EASY_LOGIN_NONCE
ユーザ属性名: かんたんログインのアクセスキー生成時に必要なNonce用。 		"im_mobile_easy_login_nonce"
Stringstatic ATTR_MY_MENU_POSITION
ユーザ属性名: マイメニュー表示位置用。 		"im_my_menu_position"
Stringstatic ATTR_REPORT_LIMIT_DAYS
ユーザ属性名: パスワード期限切れ通知用。 		"im_report_limit_days"
Stringstatic CRYPTION_CATEGORY_MOBILE_USER_AGENT
暗号化アルゴリズムカテゴリ: モバイル端末個体識別番号用。 		"mobile-user-agent"

コンストラクタの概要

AccountManager (String groupId) 非推奨
コンストラクタ。
{@link AccountInfoManager#AccountInfoManager()} を利用してください。

メソッドの概要

返却値の型 メソッド名
Boolean addAccountRole (String userId, AccountRoleInfo object) 非推奨
アカウントロールを新規追加します。
AccountInfoManager#addAccountRoleInfo(AccountRoleInfo) を利用してください。
Boolean addAccount (AccountInfo object) 非推奨
アカウントを新規に登録します。
AccountInfoManager#addAccountInfo(AccountInfo) を利用してください。
Boolean contains (String userId) 非推奨
アカウントの存在チェックを行います。
AccountInfoManager#contains(String) を利用してください。
Number count () 非推奨
アカウントの登録数を取得します。
AccountInfoManager#getAccountInfoCount() を利用してください。
Boolean deleteAccountRole (String userId, String roleId) 非推奨
アカウントロールを削除します。
AccountInfoManager#deleteAccountRoleInfo(String,String) を利用してください。
Boolean deleteAccountRoles (String userId) 非推奨
全てのアカウントロールを削除します。
AccountInfoManager#deleteAccountRoleInfos(String) を利用してください。
Boolean deleteAccount (String userId) 非推奨
アカウントを削除します。
AccountInfoManager#deleteAccountInfo(String) を利用してください。
Boolean deleteAccounts () 非推奨
すべてのアカウントを削除します。
AccountInfoManager#deleteAccountInfos() を利用してください。
Boolean deleteAttribute (String userId, String name) 非推奨
アカウント属性情報を削除します。
AccountInfoManager#deleteAttribute(String,String) を利用してください。
Array getAccountRoleIds (String userId) 非推奨
アカウントロールIDを全て取得します。
AccountInfoManager#getAccountRoleIds(String) を利用してください。
Array getAccountRoles (String userId, Date [date]) 非推奨
アカウントロールを全て取得します。
AccountInfoManager#getAccountRoleInfos(String,Date) を利用してください。
AccountInfo getAccount (String userId) 非推奨
ユーザIDにマッチしたアカウントを取得します。
AccountInfoManager#getAccountInfo(String) を利用してください。
Array getAccountsByUserIds (Array userIds) 非推奨
引数のユーザIDのアカウントをすべて取得します。
AccountInfoManager#getAccountInfosByUserCds(Array) を利用してください。
Array getAccounts () 非推奨
すべてのアカウントを取得します。
AccountInfoManager#getAccountInfos() を利用してください。
Array getAttributeNames (String userId) 非推奨
アカウント属性名の一覧を取得します。
AccountInfoManager#getAttributeNames(String) を利用してください。
String getAttribute (String userId, String name, String [def]) 非推奨
アカウント属性情報を取得します。
AccountInfoManager#getAttribute(String, String, String) を利用してください。
String getLoginGroupId () 非推奨
ログイングループIDを取得します。
代替メソッドはありません。
Array getRoleIds (String userId, Date date) 非推奨
アカウントが持つ有効なロールIDを全て取得する。
AccountInfoManager#getAccountRoleIdsRecursively(String, Date) を利用してください。
Array getUserIdsByAccountRole (String roleId) 非推奨
引数で指定したアカウントロールを持つすべてのアカウントのユーザIDを取得する。
AccountInfoManager#getUserCdsByAccountRoleId(String) を利用してください。
Array getUserIdsByAttribute (String key, String value) 非推奨
アカウント属性情報の値と一致するユーザIDを取得します。
AccountInfoManager#getUserCdsByAttribute(String, String) を利用してください。
Array getUserIdsByRole (String roleId, Date date) 非推奨
引数で指定したロールを持つすべてのアカウントのユーザIDを取得する。
AccountInfoManager#getUserCdsByRoleId(String, Date) を利用してください。
Array getUserIds () 非推奨
すべてのアカウントのユーザIDを取得します。
AccountInfoManager#getUserCds() を利用してください。
Boolean isUpdate (Date date) 非推奨
アカウント情報が指定された日付よりも後に更新されたかチェックします。
AccountInfoManager#isUpdate(Date) を利用してください。
Array searchAccounts (String userId) 非推奨
アカウントのユーザIDを検索してマッチしたアカウント取得します。
AccountInfoManager#searchAccountInfos(String) を利用してください。
Boolean setAttribute (String userId, String name, String value) 非推奨
アカウント属性情報を設定します。
AccountInfoManager#setAttribute(String,String) を利用してください。
Boolean updateAccountRole (String userId, AccountRoleInfo accountRole) 非推奨
アカウントロールを更新します。
AccountInfoManager#updateAccountRoleInfo(String,AccountRoleInfo) を利用してください。
Boolean updateAccount (AccountInfo account) 非推奨
アカウントを更新します。
AccountInfoManager#updateAccountInfo(AccountInfo) を利用してください。

コンストラクタの詳細

AccountManager (String groupId) 非推奨
AccountInfoManager#AccountInfoManager() を利用してください。
コンストラクタ。

指定したログイングループのアカウントマネージャオブジェクトを生成します。
パラメータ
groupId : String
ログイングループID

メソッドの詳細

Boolean addAccountRole (String userId, AccountRoleInfo object) 非推奨
AccountInfoManager#addAccountRoleInfo(AccountRoleInfo) を利用してください。
アカウントロールを新規追加します。

パラメータ
userId : String
ユーザID
object : AccountRoleInfo
アカウントロール情報オブジェクト
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean addAccount (AccountInfo object) 非推奨
AccountInfoManager#addAccountInfo(AccountInfo) を利用してください。
アカウントを新規に登録します。

パラメータ
object : AccountInfo
アカウント情報オブジェクト
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean contains (String userId) 非推奨
AccountInfoManager#contains(String) を利用してください。
アカウントの存在チェックを行います。

パラメータ
userId : String
ユーザID
返却値
Boolean
Boolean true : 存在する / false : 存在しない、または情報取得に失敗した場合 * @since 2.0
Number count () 非推奨
AccountInfoManager#getAccountInfoCount() を利用してください。
アカウントの登録数を取得します。

返却値
Number
Number アカウント登録数（エラーの場合は-1を返します）
Boolean deleteAccountRole (String userId, String roleId) 非推奨
AccountInfoManager#deleteAccountRoleInfo(String,String) を利用してください。
アカウントロールを削除します。

パラメータ
userId : String
削除ユーザID
roleId : String
ロールID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteAccountRoles (String userId) 非推奨
AccountInfoManager#deleteAccountRoleInfos(String) を利用してください。
全てのアカウントロールを削除します。

パラメータ
userId : String
削除ユーザID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteAccount (String userId) 非推奨
AccountInfoManager#deleteAccountInfo(String) を利用してください。
アカウントを削除します。

パラメータ
userId : String
削除対象アカウントのユーザID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteAccounts () 非推奨
AccountInfoManager#deleteAccountInfos() を利用してください。
すべてのアカウントを削除します。

返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteAttribute (String userId, String name) 非推奨
AccountInfoManager#deleteAttribute(String,String) を利用してください。
アカウント属性情報を削除します。
指定された属性名に対する属性情報が存在しない場合は、falseを返却します。
パラメータ
userId : String
ユーザID
name : String
属性名
返却値
Boolean
Boolean true : 成功 / false : 失敗
Array getAccountRoleIds (String userId) 非推奨
AccountInfoManager#getAccountRoleIds(String) を利用してください。
アカウントロールIDを全て取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
userId : String
ユーザID
返却値
Array
Array アカウントロールIDの配列
Array getAccountRoles (String userId, Date [date]) 非推奨
AccountInfoManager#getAccountRoleInfos(String,Date) を利用してください。
アカウントロールを全て取得します。

引数dateで有効範囲にあるアカウントロールの一覧を取得します。
引数dateを省略した場合は、すべてのアカウントロールの一覧が返却されます。

取得に失敗した場合は、nullを返却します。
パラメータ
userId : String
ユーザID
[date] : Date
対象日付
返却値
Array
Array アカウントロール情報オブジェクトの配列
AccountInfo getAccount (String userId) 非推奨
AccountInfoManager#getAccountInfo(String) を利用してください。
ユーザIDにマッチしたアカウントを取得します。

存在しなかった場合および取得に失敗した場合は、nullを返却します。
パラメータ
userId : String
ユーザID
返却値
AccountInfo
AccountInfo アカウント情報オブジェクト
Array getAccountsByUserIds (Array userIds) 非推奨
AccountInfoManager#getAccountInfosByUserCds(Array) を利用してください。
引数のユーザIDのアカウントをすべて取得します。

引数のユーザIDの一覧の中で存在するアカウントのみを取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
userIds : Array
ユーザIDの配列
返却値
Array
Array アカウント情報オブジェクトの配列
（データがない場合は空の配列を返します）
Array getAccounts () 非推奨
AccountInfoManager#getAccountInfos() を利用してください。
すべてのアカウントを取得します。

取得に失敗した場合は、nullを返却します。
返却値
Array
Array アカウント情報オブジェクトの配列
（データがない場合は空の配列を返します）
Array getAttributeNames (String userId) 非推奨
AccountInfoManager#getAttributeNames(String) を利用してください。
アカウント属性名の一覧を取得します。
存在しなかった場合は空の配列、取得に失敗した場合は、nullを返却します。
パラメータ
userId : String
ユーザID
返却値
Array
Array 属性名の配列
String getAttribute (String userId, String name, String [def]) 非推奨
AccountInfoManager#getAttribute(String, String, String) を利用してください。
アカウント属性情報を取得します。
指定された属性が設定されていない場合、デフォルト値が設定されている時はデフォルト値を返却します。
デフォルト値が設定されていない時は、nullを返却します。
また、属性情報の取得に失敗した場合は、nullを返却します。
パラメータ
userId : String
ユーザID
name : String
属性名
[def] : String
デフォルト値
返却値
String
String 属性値
String getLoginGroupId () 非推奨
代替メソッドはありません。
ログイングループIDを取得します。

返却値
String
String ログイングループID
Array getRoleIds (String userId, Date date) 非推奨
AccountInfoManager#getAccountRoleIdsRecursively(String, Date) を利用してください。
アカウントが持つ有効なロールIDを全て取得する。
指定日付でアカウントに紐付く有効なアカウントロールをすべて取得し、
有効なアカウントロールが持つすべてのサブロールを取得して、ロールIDの一覧を返却します。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
パラメータ
userId : String
ユーザID
date : Date
日付
返却値
Array
Array ロールIDの配列
Array getUserIdsByAccountRole (String roleId) 非推奨
AccountInfoManager#getUserCdsByAccountRoleId(String) を利用してください。
引数で指定したアカウントロールを持つすべてのアカウントのユーザIDを取得する。

引数で指定したアカウントロールを持つアカウントのユーザIDの一覧を返却します。
指定したアカウントロールの階層のチェックはお行いません。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
パラメータ
roleId : String
ロールID
返却値
Array
Array ユーザIDの配列
Array getUserIdsByAttribute (String key, String value) 非推奨
AccountInfoManager#getUserCdsByAttribute(String, String) を利用してください。
アカウント属性情報の値と一致するユーザIDを取得します。

検索対象の属性キーの値が検索値と等しいユーザIDの一覧を取得します。
存在しなかった場合は空の配列、取得に失敗した場合は、nullを返却します。
パラメータ
key : String
検索対象の属性キー名
value : String
検索値
返却値
Array
Array ユーザIDの一覧
Array getUserIdsByRole (String roleId, Date date) 非推奨
AccountInfoManager#getUserCdsByRoleId(String, Date) を利用してください。
引数で指定したロールを持つすべてのアカウントのユーザIDを取得する。 指定したロールIDからすべての親ロールを取得し、
指定日付で有効なアカウントロールを持つアカウントのユーザIDの一覧を返却します。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
パラメータ
roleId : String
ロールID
date : Date
日付
返却値
Array
Array ユーザIDの配列
Array getUserIds () 非推奨
AccountInfoManager#getUserCds() を利用してください。
すべてのアカウントのユーザIDを取得します。

存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
返却値
Array
Array ユーザIDの配列
Boolean isUpdate (Date date) 非推奨
AccountInfoManager#isUpdate(Date) を利用してください。
アカウント情報が指定された日付よりも後に更新されたかチェックします。
パラメータ
date : Date
チェック日付
返却値
Boolean
boolean 判定結果　更新された : true / 更新されていない ： false
Array searchAccounts (String userId) 非推奨
AccountInfoManager#searchAccountInfos(String) を利用してください。
アカウントのユーザIDを検索してマッチしたアカウント取得します。
ユーザIDまたはユーザIDの一部をキーとして検索し、マッチしたアカウントを返します。
ただし、以下の文字列を特殊文字列として扱う。
* 0以上の長さの文字列とマッチ
? 1文字の文字列とマッチ

取得に失敗した場合は、nullを返却します。
パラメータ
userId : String
検索キー
返却値
Array
Array アカウント情報オブジェクトの配列
（データがない場合は空の配列を返します）
Boolean setAttribute (String userId, String name, String value) 非推奨
AccountInfoManager#setAttribute(String,String) を利用してください。
アカウント属性情報を設定します。
引数で指定した属性名に一致する属性情報が存在しない場合は、新規に登録します。
引数で指定した属性名に一致する属性情報がすでに存在する場合は、指定された属性値で更新します。
パラメータ
userId : String
ユーザID
name : String
属性名
value : String
属性値
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean updateAccountRole (String userId, AccountRoleInfo accountRole) 非推奨
AccountInfoManager#updateAccountRoleInfo(String,AccountRoleInfo) を利用してください。
アカウントロールを更新します。

パラメータ
userId : String
ユーザID
accountRole : AccountRoleInfo
アカウントロール情報オブジェクト
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean updateAccount (AccountInfo account) 非推奨
AccountInfoManager#updateAccountInfo(AccountInfo) を利用してください。
アカウントを更新します。

パラメータ
account : AccountInfo
アカウント情報オブジェクト
返却値
Boolean
Boolean true : 成功 / false : 失敗

Copyright © 2012 NTT DATA INTRAMART CORPORATION