アカウントマネージャオブジェクト
アカウント情報の参照、更新を行うマネージャオブジェクトです。
アカウント情報を操作する場合に用いるアカウントオブジェクトの構成は以下の通りです。
アカウントオブジェクト
アカウント
オブジェクト
(Object)encoding エンコーディング (String)
goOut 外出フラグ (Boolean)
locale ロケール (String)
lockDate アカウントロック日付 (String)
loginFailureCount ログイン失敗回数 (Number)
mainPagePatternId メインページパターンID (String)
mobilePassword モバイル用パスワード (String)
note 説明 (String)
colorPatternId カラーパターンID (String)
password パスワード (String)
userId ユーザID (String)
validEndDate 有効終了日 (Date)
validStartDate 有効開始日 (Date)
アカウントロール情報を操作する場合に用いるアカウントロールオブジェクトの構成は以下の通りです。
アカウントロールオブジェクト
アカウント
ロールオブジェクト
(Object)roleId
ロールID(String)validEndDate
アカウントロール用の有効期間終了日を保存する属性名 (Date)
validStartDate
アカウントロール用の有効期間開始日を保存する属性名 (Date)
マイメニュー情報を操作する場合に用いるマイメニューオブジェクトの構成は以下の通りです。
マイメニューオブジェクト
マイメニュー
オブジェクト
(Object)name
マイメニュー情報・表示名ID (String)menuId
マイメニュー情報・メニューID (String)
sortNum
マイメニュー情報・ソート番号 (String)
バージョン:2.0
導入されたバージョン:2.0
コンストラクタの概要 | |
AccountManager(String groupId) |
メソッドの概要 | |
| addAccount(Object object) |
| addAccountRole(String userId ,Object object) |
| addFavoriteMenu(String userId ,Object object) |
| contains(String userId) |
| count() |
| del(String uid [,Array funcs] [,Boolean isTransaction]) 推奨されていません。AccountManager.deleteAccount(String userId) に置き換えられました。 |
| deleteAccount(String userId) |
| deleteAccountRole(String userId ,String roleId) |
| deleteAccountRoles(String userId) |
| deleteAccounts() |
| exportData(String category) |
| get(String userId) 推奨されていません。AccountManager.getAccount(String userId) に置き換えられました。 |
| getAccount(String userId) |
| getAccountRoleIds(String userId) |
| getAccountRoles(String userId [,Date date]) |
| getAccounts() |
| getAccountsByUserIds(Array userIds) |
| getFavoriteMenuIds(String userId) |
| getFavoriteMenus(String userId) |
| getKeys() 推奨されていません。AccountManager.getUserIds() に置き換えられました。 |
| getLoginGroupId() |
| getRoleIds(String userId ,Date date) |
| getUserIds() |
| getUserIdsByAccountRole(String roleId) |
| getUserIdsByRole(String roleId ,Date date) |
| importData(String category ,String str) |
| searchAccounts(String userId) |
| set(Object request [,Array funcs] [,Boolean isTransaction]) 推奨されていません。AccountManager.addAccount(Object account) および AccountManager.updateAccount(Object account)に置き換えられました。 |
| updateAccount(Object account) |
| updateAccountRole(String userId ,Object accountRole) |
| updateFavoriteMenu(String userId ,Object favoriteMenu) |
コンストラクタの詳細 |
コンストラクタ。
指定したログイングループのアカウントマネージャオブジェクトを生成します。
パラメータ
groupId String ログイングループID
導入されたバージョン:2.0
メソッドの詳細 |
| addAccount(Object object) |
アカウントを新規に登録します。
パラメータ
object Object アカウントオブジェクト
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| addAccountRole(String userId ,Object object) |
アカウントロールを新規追加します。
パラメータ
userId String ユーザID object Object アカウントロールオブジェクト
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| addFavoriteMenu(String userId ,Object object) |
マイメニューを新規追加します。
パラメータ
userId String ユーザID object Object マイメニューオブジェクト
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| contains(String userId) |
アカウントの存在チェックを行います。
パラメータ
userId String ユーザID
返却値
Boolean true : 存在する / false : 存在しない、または情報取得に失敗した場合 * @since 2.0
| count() |
アカウントの登録数を取得します。
返却値
Number アカウント登録数(エラーの場合は-1を返します)
導入されたバージョン:2.0
| del(String uid [,Array funcs] [,Boolean isTransaction]) |
推奨されていません。AccountManager.deleteAccount(String userId) に置き換えられました。
アカウントを削除します。
パラメータ
uid String ユーザID funcs Array 動かしたい関数があれば、パスを配列にいれて渡します。(任意) isTransaction Boolean DBトランザクションフラグ(任意)
trueの場合 このメソッドの中でDBトランザクションを張る。
falseの場合 このメソッドの中でDBトランザクションを張らない。デフォルトはtrue。
返却値
Object 結果オブジェクトまたは、引数が不正の場合、falseを返却します。
結果オブジェクト getCode() エラーコード
-1 実行エラー
0 成功
その他 各アプリに依存getMessage() エラーメッセージ
導入されたバージョン:2.0
| deleteAccount(String userId) |
アカウントを削除します。
パラメータ
userId String 削除対象アカウントのユーザID
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| deleteAccountRole(String userId ,String roleId) |
アカウントロールを削除します。
パラメータ
userId String 削除ユーザID roleId String ロールID
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| deleteAccountRoles(String userId) |
全てのアカウントロールを削除します。
パラメータ
userId String 削除ユーザID
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| deleteAccounts() |
すべてのアカウントを削除します。
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| exportData(String category) |
アカウントのエクスポートを行います。
パラメータ
category String カテゴリ
返却値
String String 出力情報
エクスポートに失敗した場合は、nullを返却します。
導入されたバージョン:5.0
| get(String userId) |
推奨されていません。AccountManager.getAccount(String userId) に置き換えられました。
アカウントを取得します。
パラメータ
userId String ユーザID
返却値
DataForAccount DataForAccountオブジェクト
存在しない場合はnullを返却します。
導入されたバージョン:2.0
| getAccount(String userId) |
ユーザIDにマッチしたアカウントを取得します。
存在しなかった場合および取得に失敗した場合は、nullを返却します。
パラメータ
userId String ユーザID
返却値
Object アカウントオブジェクト
| getAccountRoleIds(String userId) |
アカウントロールIDを全て取得します。
取得に失敗した場合は、nullを返却します。
パラメータ
userId String ユーザID
返却値
Array アカウントロールIDの配列
導入されたバージョン:5.0
| getAccountRoles(String userId [,Date date]) |
アカウントロールを全て取得します。
引数dateで有効範囲にあるアカウントロールの一覧を取得します。
引数dateを省略した場合は、すべてのアカウントロールの一覧が返却されます。
取得に失敗した場合は、nullを返却します。
パラメータ
userId String ユーザID date Date 対象日付
返却値
Array アカウントロールオブジェクト の配列
導入されたバージョン:5.0
| getAccounts() |
すべてのアカウントを取得します。
取得に失敗した場合は、nullを返却します。
返却値
Array アカウントオブジェクト の配列(データがない場合は空の配列を返します)
導入されたバージョン:5.0
| getAccountsByUserIds(Array userIds) |
引数のユーザIDのアカウントをすべて取得します。
引数のユーザIDの一覧の中で存在するアカウントのみを取得します。
取得に失敗した場合は、nullを返却します。
パラメータ
userIds Array ユーザIDの配列
返却値
Array アカウントオブジェクト の配列(データがない場合は空の配列を返します)
導入されたバージョン:5.0
| getFavoriteMenuIds(String userId) |
マイメニューIDを全て取得します。
取得に失敗した場合は、nullを返却します。
パラメータ
userId String ユーザID
返却値
Array マイメニューIDの配列
導入されたバージョン:5.0
| getFavoriteMenus(String userId) |
マイメニューを全て取得します。
取得に失敗した場合は、nullを返却します。
パラメータ
userId String ユーザID
返却値
Array マイメニューオブジェクト の配列
導入されたバージョン:5.0
| getKeys() |
推奨されていません。AccountManager.getUserIds() に置き換えられました。
ユーザIDをすべて取得します。
返却値
Array ユーザIDの配列。
存在しない場合は空の配列を返却します。
導入されたバージョン:2.0
| getLoginGroupId() |
ログイングループIDを取得します。
返却値
String ログイングループID
導入されたバージョン:5.0
| getRoleIds(String userId ,Date date) |
アカウントが持つ有効なロールIDを全て取得する。
指定日付でアカウントに紐付く有効なアカウントロールをすべて取得し、
有効なアカウントロールが持つすべてのサブロールを取得して、ロールIDの一覧を返却します。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
パラメータ
userId String ユーザID date Date 日付
返却値
Array ロールIDの配列
導入されたバージョン:5.0
| getUserIds() |
すべてのアカウントのユーザIDを取得します。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
返却値
Array ユーザIDの配列
導入されたバージョン:5.0
| getUserIdsByAccountRole(String roleId) |
引数で指定したアカウントロールを持つすべてのアカウントのユーザIDを取得する。
引数で指定したアカウントロールを持つアカウントのユーザIDの一覧を返却します。
指定したアカウントロールの階層のチェックはお行いません。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
パラメータ
roleId String ロールID
返却値
Array ユーザIDの配列
導入されたバージョン:5.0
| getUserIdsByRole(String roleId ,Date date) |
引数で指定したロールを持つすべてのアカウントのユーザIDを取得する。 指定したロールIDからすべての親ロールを取得し、
指定日付で有効なアカウントロールを持つアカウントのユーザIDの一覧を返却します。
存在しなかった場合および取得に失敗した場合は、空の配列を返却します。
パラメータ
roleId String ロールID date Date 日付
返却値
Array ユーザIDの配列
導入されたバージョン:5.0
| importData(String category ,String str) |
アカウントのインポートを行います。
パラメータ
category String カテゴリ str String ストリーム
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| searchAccounts(String userId) |
アカウントのユーザIDを検索してマッチしたアカウント取得します。
ユーザIDまたはユーザIDの一部をキーとして検索し、マッチしたアカウントを返します。
ただし、以下の文字列を特殊文字列として扱う。
* 0以上の長さの文字列とマッチ
? 1文字の文字列とマッチ
取得に失敗した場合は、nullを返却します。
パラメータ
userId String 検索キー
返却値
Array アカウントオブジェクト の配列(データがない場合は空の配列を返します)
導入されたバージョン:5.0
| set(Object request [,Array funcs] [,Boolean isTransaction]) |
推奨されていません。AccountManager.addAccount(Object account) および AccountManager.updateAccount(Object account)に置き換えられました。
アカウントを登録します。
引数に指定したユーザIDが既に存在していた場合、上書きします。
request
リクエストオブジェクトid ユーザID(String)[必須] pwd パスワード(String) mpwd モバイル用パスワード(String) name ユーザ名(String)[必須] madrs メールアドレス(String) mbladrs モバイル用メールアドレス(String) explan 説明(String) vldDate 有効期限(Number(ミリ秒)) roles ロールIDの配列(Array) license ライセンス(あり true/なし false) apps アプリケーションロール(Array) favorite マイメニュー(Object) メニューID (プロパティ) sort_no ソート番号 (Number) alias 表示名(String) kana ユーザ名カナ(String) eng ユーザ名英字(String) tel 電話番号(String) hndy 携帯電話番号(String) fax FAX番号(String) extens 内線電話番号(String) exFax 内線FAX(String) cntry_cd 国コード(String) zip 郵便番号(String) adrs 住所(String) madrs2 メールアドレス2(String) url URL(String) note 備考(String) sort_key ソート番号(Number) mainGp 主所属グループCD(String) groups 所属グループCDの配列(主所属グループは含めない)(Array) その他 各アプリに依存
パラメータ
request Object 登録画面からのリクエストオブジェクト funcs Array 動かしたい関数があれば、パスを配列にいれて渡す(任意) isTransaction Boolean DBトランザクションフラグ(任意)
trueの場合 このメソッドの中でDBトランザクションを張る。
falseの場合 このメソッドの中でDBトランザクションを張らない。デフォルトはtrue。
返却値
Object 結果オブジェクトまたは、引数が不正の場合、falseを返却します。
結果オブジェクト
(Object)getCode() エラーコード
-1 実行エラー
0 成功
その他 各アプリに依存getMessage() エラーメッセージ
導入されたバージョン:2.0
| updateAccount(Object account) |
アカウントを更新します。
パラメータ
account Object アカウントオブジェクト
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| updateAccountRole(String userId ,Object accountRole) |
アカウントロールを更新します。
パラメータ
userId String ユーザID accountRole Object アカウントロールオブジェクト
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0
| updateFavoriteMenu(String userId ,Object favoriteMenu) |
マイメニューを更新します。
パラメータ
userId String ユーザID favoriteMenu Object マイメニューオブジェクト
返却値
Boolean true : 成功 / false : 失敗
導入されたバージョン:5.0