RoleInfoManagerオブジェクト

コンポーネント情報
version	8.0.37
since	8.0.0

コンポーネント概要

ロールマネージャクラス。

ロール情報に関連する操作を行います。

コンストラクタの概要

RoleInfoManager () コンストラクタ。

メソッドの概要

返却値の型	メソッド名
ResultObject	addRoleInfo (RoleInfo `roleInfo`) ロール情報を新規登録します。
ResultObject	addSubRoleInfo (String `roleId`, String `subRoleId`) 指定されたロールのサブロールを追加します。
ResultObject	certify (Array `nestRoleIds`, Array `roleIds`) ロール内包をチェックします。
ResultObject	containsCategory (String `category`) 指定されたカテゴリが登録されているかチェックします。
ResultObject	containsRoleName (String `roleName`, String `exceptRoleId`) 指定されたロール名が登録されているかチェックします。
ResultObject	containsRoleName (String `roleName`) 指定されたロール名が登録されているかチェックします。
ResultObject	contains (String `roleId`) 指定されたロールが登録されているかチェックします。
ResultObject	deleteCategories () すべてのカテゴリを削除します。
ResultObject	deleteCategory (String `category`) カテゴリを削除します。
ResultObject	deleteRoleInfo (String `roleId`) ロールを削除します。
ResultObject	deleteRoleInfos () すべてのロールを削除します。
ResultObject	deleteSubRoleInfo (String `roleId`, String `subRoleId`) 指定したサブロールの関係を削除します。
ResultObject	deleteSubRoleInfos (String `roleId`) 指定したロールの全てのサブロールの関係を削除します。
ResultObject	getAllParentRoleIds (String `roleId`) 全ての親ロールIDを取得します。
ResultObject	getAllSubRoleIds (String `roleId`) 全てのサブロールIDを取得します。
ResultObject	getCategories () カテゴリの一覧を取得します。
ResultObject	getCategoryCount (String `category`) 非推奨カテゴリに属するロール数を取得します。 getRoleInfoCountByCategory(String) を使用してください。
ResultObject	getParentRoleIds (String `roleId`) 指定されたロールの親ロールIDを取得します。
ResultObject	getRoleIds () すべてのロールIDを取得します。
ResultObject	getRoleInfoCountByCategoryAndRoleName (String `[category]`, String `[roleName]`, String `[locale]`) 指定されたロールカテゴリとロール名にマッチするロール数を返却します。
ResultObject	getRoleInfoCountByCategory (String `category`) カテゴリに属するロール数を取得します。
ResultObject	getRoleInfoCount () ロール数を取得します。
ResultObject	getRoleInfo (String `roleId`) ロール情報を取得します。
ResultObject	getRoleInfosByCategory (String `category`) カテゴリ検索によりロールを取得します。
ResultObject	getRoleInfosByRoleIds (Array `roleIds`) 引数で指定したロールIDのロール情報をすべて取得します。
ResultObject	getRoleInfos () すべてのロール情報を取得します。
ResultObject	getSubRoleIds (String `roleId`) サブロール(一階層のみ)を取得します。
ResultObject	isUpdate (Date `date`) ロール情報が指定された日付以降に更新されているかチェックします。
ResultObject	moveCategory (String `oldCategory`, String `newCategory`) カテゴリを更新します。
ResultObject	searchRoleInfosByCategoryAndRoleName (String `[category]`, String `[roleName]`, String `[locale]`, Number `[limit]`, Number `[offset]`, String `[sortIndex]`, String `[sortOrder]`) 指定されたロールカテゴリとロール名にマッチするロール情報を返却します。
ResultObject	searchRoleInfosByRoleId (String `roleId`) 指定された検索文字列にマッチするロールIDを持つロール情報を返却します。
ResultObject	searchRoleInfosByRoleName (String `roleName`) 指定された検索文字列にマッチするロール名を持つロール情報を返却します。
ResultObject	updateRoleInfo (RoleInfo `roleInfo`) ロール情報を更新します。

コンストラクタの詳細

RoleInfoManager ()

コンストラクタ。

メソッドの詳細

ResultObject addRoleInfo (RoleInfo roleInfo)

ロール情報を新規登録します。

パラメータ

roleInfo : RoleInfo: ロール情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject addSubRoleInfo (String roleId, String subRoleId)

指定されたロールのサブロールを追加します。

パラメータ

roleId : String: ロールID

subRoleId : String: サブロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject certify (Array nestRoleIds, Array roleIds)

ロール内包をチェックします。

第1引数で指定されたロールIDが第2引数で指定されたロールIDを内包しているかチェックします。
第1引数のロールIDのみ、ネストしたロールも含めてチェックします。

パラメータ

nestRoleIds : Array: ロールIDの配列

roleIds : Array: ロールIDの配列

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには同じロールIDが内包している場合は true、内包していない場合は false が設定されます。

ResultObject containsCategory (String category)

指定されたカテゴリが登録されているかチェックします。

パラメータ

category : String: カテゴリ

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには登録されている場合 true、それ以外の場合 false が設定されます。

ResultObject containsRoleName (String roleName, String exceptRoleId)

指定されたロール名が登録されているかチェックします。

第2引数に指定されたロールを除いた全てのロールに対してロール名が存在するかをチェックします。

パラメータ

roleName : String: ロール名

exceptRoleId : String: 除外するロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには登録されている場合 true、それ以外の場合 false が設定されます。

ResultObject containsRoleName (String roleName)

指定されたロール名が登録されているかチェックします。

全てのロールに対して指定のロール名が存在するかをチェックします。

パラメータ

roleName : String: ロール名

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには登録されている場合 true、それ以外の場合 false が設定されます。

ResultObject contains (String roleId)

指定されたロールが登録されているかチェックします。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには登録されている場合 true、それ以外の場合 false が設定されます。

ResultObject deleteCategories ()

すべてのカテゴリを削除します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject deleteCategory (String category)

カテゴリを削除します。

パラメータ

category : String: カテゴリ

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject deleteRoleInfo (String roleId)

ロールを削除します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject deleteRoleInfos ()

すべてのロールを削除します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject deleteSubRoleInfo (String roleId, String subRoleId)

指定したサブロールの関係を削除します。

パラメータ

roleId : String: ロールID

subRoleId : String: サブロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject deleteSubRoleInfos (String roleId)

指定したロールの全てのサブロールの関係を削除します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject getAllParentRoleIds (String roleId)

全ての親ロールIDを取得します。

指定したロールに属する親ロールのロールIDをすべて取得します。
ネストした親ロールについても全て取得します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには親ロールIDの一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getAllSubRoleIds (String roleId)

全てのサブロールIDを取得します。

指定したロールに属するサブロールのロールIDをすべて取得します。
ネストしたサブロールについても全て取得します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはサブロールIDの一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getCategories ()

カテゴリの一覧を取得します。

重複を除いた全てのカテゴリを取得します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはカテゴリの一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getCategoryCount (String category) 非推奨

getRoleInfoCountByCategory(String) を使用してください。

カテゴリに属するロール数を取得します。

パラメータ

category : String: カテゴリ

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール数が設定されます。

ResultObject getParentRoleIds (String roleId)

指定されたロールの親ロールIDを取得します。

指定のロールの一階層上のロールを取得します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには親ロールIDの一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getRoleIds ()

すべてのロールIDを取得します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロールIDの一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getRoleInfoCountByCategoryAndRoleName (String [category], String [roleName], String [locale])

指定されたロールカテゴリとロール名にマッチするロール数を返却します。

ロール名は、以下の文字を特殊文字として扱います。
* 0 以上の長さの文字列とマッチ
? 1 文字の文字列とマッチ

パラメータ

[category] : String: ロールカテゴリ

[roleName] : String: ロール名

[locale] : String: ロケールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール数が設定されます。

ResultObject getRoleInfoCountByCategory (String category)

カテゴリに属するロール数を取得します。

パラメータ

category : String: カテゴリ

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール数が設定されます。

ResultObject getRoleInfoCount ()

ロール数を取得します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール数が設定されます。

ResultObject getRoleInfo (String roleId)

ロール情報を取得します。

指定されたロールの情報を取得します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報が設定されます。

ResultObject getRoleInfosByCategory (String category)

カテゴリ検索によりロールを取得します。

指定したカテゴリに属するロール情報を全て取得します。

パラメータ

category : String: カテゴリ

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報の一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getRoleInfosByRoleIds (Array roleIds)

引数で指定したロールIDのロール情報をすべて取得します。

パラメータ

roleIds : Array: ロールIDの配列

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報の一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getRoleInfos ()

すべてのロール情報を取得します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報の一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject getSubRoleIds (String roleId)

サブロール(一階層のみ)を取得します。

パラメータ

roleId : String: ロールID

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはサブロールIDの一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject isUpdate (Date date)

ロール情報が指定された日付以降に更新されているかチェックします。

パラメータ

date : Date: チェック日付

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには指定された日付以降に更新されている場合は true、それ以外の場合は false が設定されます。

ResultObject moveCategory (String oldCategory, String newCategory)

カテゴリを更新します。

パラメータ

oldCategory : String: 旧カテゴリ

newCategory : String: 新カテゴリ

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。

ResultObject searchRoleInfosByCategoryAndRoleName (String [category], String [roleName], String [locale], Number [limit], Number [offset], String [sortIndex], String [sortOrder])

指定されたロールカテゴリとロール名にマッチするロール情報を返却します。

ロール名は、以下の文字を特殊文字として扱います。
* 0 以上の長さの文字列とマッチ
? 1 文字の文字列とマッチ

パラメータ

[category] : String: ロールカテゴリ

[roleName] : String: ロール名

[locale] : String: ロケールID

[limit] : Number: リミット

[offset] : Number: オフセット

[sortIndex] : String: ソート列（category, role_name, display_name のいずれか）

[sortOrder] : String: ソート順（ASC、または、DESC）

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報の一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject searchRoleInfosByRoleId (String roleId)

指定された検索文字列にマッチするロールIDを持つロール情報を返却します。

以下の文字を特殊文字として扱います。
* 0 以上の長さの文字列とマッチ
? 1 文字の文字列とマッチ

パラメータ

roleId : String: 検索文字列

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報の一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject searchRoleInfosByRoleName (String roleName)

指定された検索文字列にマッチするロール名を持つロール情報を返却します。

以下の文字を特殊文字として扱います。
* 0 以上の長さの文字列とマッチ
? 1 文字の文字列とマッチ

パラメータ

roleName : String: ロール名検索文字列

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティにはロール情報の一覧が設定されます。
データがない場合が空の一覧が設定されます。

ResultObject updateRoleInfo (RoleInfo roleInfo)

ロール情報を更新します。

パラメータ

roleInfo : RoleInfo: ロール情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。