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

RoleManagerオブジェクト非推奨

RoleInfoManager を使用してください。
コンポーネント情報
version1.0
since5.0
コンポーネント概要
ロールマネージャオブジェクト。

ロール情報の参照、更新を行うマネージャオブジェクトです。

コンストラクタの概要

RoleManager (String loginGroupId) 非推奨
コンストラクタ。
{@link RoleInfoManager#RoleInfoManager()} を使用してください。

メソッドの概要

返却値の型 メソッド名
Boolean addRole (RoleInfo role) 非推奨
ロール情報を新規登録します。
RoleInfoManager#addRoleInfo(RoleInfo) を使用してください。
Boolean addSubRole (String roleId, String subRoleId) 非推奨
サブロールIDを追加します。
RoleInfoManager#addSubRoleInfo(String,String) を使用してください。
Boolean certify (Array users, Array roles) 非推奨
ロール認証を行います。
RoleInfoManager#certify(Array,Array) を使用してください。
Boolean containsCategory (String category) 非推奨
カテゴリーの登録チェックを行います。
RoleInfoManager#containsCategory(String) を使用してください。
Boolean contains (String roleId) 非推奨
ロールの存在チェックを行います。
RoleInfoManager#contains(String) を使用してください。
Number countByCategory (String category) 非推奨
カテゴリーに属するロール数を取得します。
RoleInfoManager#getRoleInfoCountByCategory(String) を使用してください。
Number count () 非推奨
ロール数を取得します。
RoleInfoManager#getRoleInfoCount() を使用してください。
Boolean deleteCategories () 非推奨
カテゴリーを全件削除します。
RoleInfoManager#deleteCategories() を使用してください。
Boolean deleteCategory (String category) 非推奨
カテゴリーを削除します。
RoleInfoManager#deleteCategory(String) を使用してください。
Boolean deleteRole (String roleId) 非推奨
ロールを削除します。
RoleInfoManager#deleteRoleInfo(String) を使用してください。
Boolean deleteRoles () 非推奨
ロールを全削除します。
RoleInfoManager#deleteRoleInfos() を使用してください
Boolean deleteSubRole (String roleId, String subRoleId) 非推奨
指定したサブロールIDを削除します。
RoleInfoManager#deleteSubRole(String,String) を使用してください。
Boolean deleteSubRoles (String roleId) 非推奨
全てのサブロールIDを削除します。
RoleInfoManager#deleteSubRoleInfos(String) を使用してください。
Array getAllParentRoleIds (String roleId) 非推奨
全ての親ロールIDを取得します。
RoleInfoManager#getAllParentRoleIds(String) を使用してください。
Array getAllSubRoleIds (String roleId) 非推奨
指定したロールIDのサブロールサマリを取得します。
RoleInfoManager#getAllSubRoleIds(String) を使用してください。
Array getCategories () 非推奨
カテゴリー一覧を取得します。
RoleInfoManager#getCategories() を使用してください。
String getLoginGroupId () 非推奨
ログイングループIDを取得します。
代替メソッドはありません。
Array getParentRoleIds (String roleId) 非推奨
親ロール(一階層上のみ)を取得します。
RoleInfoManager#getParentRoleIds(String) を使用してください。
Array getRoleIds () 非推奨
すべてのロールIDを取得します。
RoleInfoManager#getRoleIds() を使用してください。
RoleInfo getRole (String roleId) 非推奨
ロール情報を取得します。
RoleInfoManager#getRoleInfo(String) を使用してください。
Array getRolesByCategory (String category) 非推奨
カテゴリーで検索を行い、ロールを取得します。
RoleInfoManager#getRoleInfosByCategory(String) を使用してください。
Array getRolesByIds (Array roleIds) 非推奨
引数のロールIDのロールをすべて取得します。
RoleInfoManager#getRoleInfosByRoleIds(Array) を使用してください。
Array getRoles () 非推奨
ロール情報を全取得します。
RoleInfoManager#getRoleInfos() を使用してください。
Array getSubRole (String roleId) 非推奨
サブロール(一階層のみ)を取得します。
RoleInfoManager#getSubRoleIds() を使用してください。
Boolean isUpdate (Date date) 非推奨
ロール情報が指定された日付よりも後に更新されたかチェックします。
RoleInfoManager#isUpdate(Date) を使用してください。
Boolean moveCategory (String oldCategory, String newCategory) 非推奨
カテゴリーを更新します。
RoleInfoManager#moveCategory(String,String) を使用してください。
Array searchRolesById (String key) 非推奨
ロールID検索によりロールを取得します。
RoleInfoManager#searchRoleInfosByRoleId(String) を使用してください。
Array searchRolesByName (String name) 非推奨
ロール名称検索でロールを取得します。
RoleInfoManager#searchRoleInfosByRoleName(String) を使用してください。
Boolean updateRole (RoleInfo role) 非推奨
ロール情報を更新します。
RoleInfoManager#updateRoleInfo(RoleInfo) を使用してください。

コンストラクタの詳細

RoleManager (String loginGroupId) 非推奨
RoleInfoManager#RoleInfoManager() を使用してください。
コンストラクタ。

パラメータ
loginGroupId : String
ログイングループID

メソッドの詳細

Boolean addRole (RoleInfo role) 非推奨
RoleInfoManager#addRoleInfo(RoleInfo) を使用してください。
ロール情報を新規登録します。

パラメータ
role : RoleInfo
ロール情報オブジェクト
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean addSubRole (String roleId, String subRoleId) 非推奨
RoleInfoManager#addSubRoleInfo(String,String) を使用してください。
サブロールIDを追加します。

パラメータ
roleId : String
ロールID
subRoleId : String
サブロールID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean certify (Array users, Array roles) 非推奨
RoleInfoManager#certify(Array,Array) を使用してください。
ロール認証を行います。

パラメータ
users : Array
userDataのロールID(String)の配列
roles : Array
その他のオブジェクトのロールID(String)の配列
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean containsCategory (String category) 非推奨
RoleInfoManager#containsCategory(String) を使用してください。
カテゴリーの登録チェックを行います。

パラメータ
category : String
カテゴリ名
返却値
Boolean
Boolean true:登録有り false:登録なし または エラー発生
Boolean contains (String roleId) 非推奨
RoleInfoManager#contains(String) を使用してください。
ロールの存在チェックを行います。

パラメータ
roleId : String
ロールID
返却値
Boolean
Boolean true:存在する false:存在しない
Number countByCategory (String category) 非推奨
RoleInfoManager#getRoleInfoCountByCategory(String) を使用してください。
カテゴリーに属するロール数を取得します。

パラメータ
category : String
カテゴリ
返却値
Number
Number カテゴリーに属するロール数（エラーの場合は-1を返します）
Number count () 非推奨
RoleInfoManager#getRoleInfoCount() を使用してください。
ロール数を取得します。

返却値
Number
Number ロールの数（エラーの場合は-1を返します）
Boolean deleteCategories () 非推奨
RoleInfoManager#deleteCategories() を使用してください。
カテゴリーを全件削除します。

返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteCategory (String category) 非推奨
RoleInfoManager#deleteCategory(String) を使用してください。
カテゴリーを削除します。

パラメータ
category : String
カテゴリ名
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteRole (String roleId) 非推奨
RoleInfoManager#deleteRoleInfo(String) を使用してください。
ロールを削除します。

パラメータ
roleId : String
ロールID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteRoles () 非推奨
RoleInfoManager#deleteRoleInfos() を使用してください
ロールを全削除します。

返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteSubRole (String roleId, String subRoleId) 非推奨
RoleInfoManager#deleteSubRole(String,String) を使用してください。
指定したサブロールIDを削除します。

パラメータ
roleId : String
ロールID
subRoleId : String
サブロールID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Boolean deleteSubRoles (String roleId) 非推奨
RoleInfoManager#deleteSubRoleInfos(String) を使用してください。
全てのサブロールIDを削除します。

パラメータ
roleId : String
ロールID
返却値
Boolean
Boolean true : 成功 / false : 失敗
Array getAllParentRoleIds (String roleId) 非推奨
RoleInfoManager#getAllParentRoleIds(String) を使用してください。
全ての親ロールIDを取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
roleId : String
ロールID
返却値
Array
Array 全ての親ロールIDの配列
Array getAllSubRoleIds (String roleId) 非推奨
RoleInfoManager#getAllSubRoleIds(String) を使用してください。
指定したロールIDのサブロールサマリを取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
roleId : String
ロールID
返却値
Array
Array 指定されたロールIDのサブロールの配列（エラーの場合はnullを返します。）
Array getCategories () 非推奨
RoleInfoManager#getCategories() を使用してください。
カテゴリー一覧を取得します。

取得に失敗した場合は、nullを返却します。
返却値
Array
Array カテゴリの配列（エラーの場合はnullを返します。）
String getLoginGroupId () 非推奨
代替メソッドはありません。
ログイングループIDを取得します。

取得に失敗した場合は、nullを返却します。
返却値
String
String ログイングループID
Array getParentRoleIds (String roleId) 非推奨
RoleInfoManager#getParentRoleIds(String) を使用してください。
親ロール(一階層上のみ)を取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
roleId : String
ロールID
返却値
Array
Array 親ロールIDの配列
Array getRoleIds () 非推奨
RoleInfoManager#getRoleIds() を使用してください。
すべてのロールIDを取得します。

取得に失敗した場合は、nullを返却します。
返却値
Array
Array ロールIDの配列
RoleInfo getRole (String roleId) 非推奨
RoleInfoManager#getRoleInfo(String) を使用してください。
ロール情報を取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
roleId : String
ロールID
返却値
RoleInfo
RoleInfo ロール情報オブジェクト
Array getRolesByCategory (String category) 非推奨
RoleInfoManager#getRoleInfosByCategory(String) を使用してください。
カテゴリーで検索を行い、ロールを取得します。

指定したカテゴリーに属するロール情報を全て取得します。
取得に失敗した場合は、nullを返却します。
パラメータ
category : String
カテゴリ名
返却値
Array
Array 指定されたカテゴリに属するロール情報オブジェクトの配列
Array getRolesByIds (Array roleIds) 非推奨
RoleInfoManager#getRoleInfosByRoleIds(Array) を使用してください。
引数のロールIDのロールをすべて取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
roleIds : Array
ロールIDの配列
返却値
Array
Array ロール情報オブジェクトの配列（データがない場合は空の配列を返します）
Array getRoles () 非推奨
RoleInfoManager#getRoleInfos() を使用してください。
ロール情報を全取得します。

取得に失敗した場合は、nullを返却します。
返却値
Array
Array ロール情報オブジェクトの配列
Array getSubRole (String roleId) 非推奨
RoleInfoManager#getSubRoleIds() を使用してください。
サブロール(一階層のみ)を取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
roleId : String
ロールID
返却値
Array
Array サブロールIDの配列
Boolean isUpdate (Date date) 非推奨
RoleInfoManager#isUpdate(Date) を使用してください。
ロール情報が指定された日付よりも後に更新されたかチェックします。
パラメータ
date : Date
チェック日付
返却値
Boolean
boolean 判定結果　更新された : true / 更新されていない ： false
Boolean moveCategory (String oldCategory, String newCategory) 非推奨
RoleInfoManager#moveCategory(String,String) を使用してください。
カテゴリーを更新します。

パラメータ
oldCategory : String
変更前のカテゴリ名
newCategory : String
変更後のカテゴリ名
返却値
Boolean
Boolean true : 成功 / false : 失敗
Array searchRolesById (String key) 非推奨
RoleInfoManager#searchRoleInfosByRoleId(String) を使用してください。
ロールID検索によりロールを取得します。

引数に類似(前方一致)するロールIDを持つロール情報を全て取得します。
取得に失敗した場合は、nullを返却します。
パラメータ
key : String
検索ロールID
返却値
Array
Array ロール情報オブジェクトの配列
(検索にヒットしない場合は空の配列。)
Array searchRolesByName (String name) 非推奨
RoleInfoManager#searchRoleInfosByRoleName(String) を使用してください。
ロール名称検索でロールを取得します。

取得に失敗した場合は、nullを返却します。
パラメータ
name : String
ロールの名称
返却値
Array
Array ロール情報オブジェクトの配列
Boolean updateRole (RoleInfo role) 非推奨
RoleInfoManager#updateRoleInfo(RoleInfo) を使用してください。
ロール情報を更新します。
パラメータ
role : RoleInfo
ロール情報オブジェクト
返却値
Boolean
Boolean true : 成功 / false : 失敗

Copyright © 2012 NTT DATA INTRAMART CORPORATION