コンストラクタの概要

IMMPrivateGroupManager (String [updateUserCd], String [defaultLocale])
コンストラクタ
IMMPrivateGroupManager (String updateUserCd, String defaultLocale, String loginGroupId) 非推奨
コンストラクタ
IMMPrivateGroupManager([String updateUserCd][,String defaultLocale])を使用してください。

メソッドの概要

返却値の型 メソッド名
BizApiResultInfo countPrivateGroup (AppCmnSearchCondition condition)
指定された条件に該当するプライベートグループの個数を取得します。
BizApiResultInfo countUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, String locale, Boolean isDisable)
指定された条件を元に引数のプライベートグループに所属するユーザ数を取得します。
BizApiResultInfo getPrivateGroup (PrivateGroupBizKeyInfo bizKey)
引数のプライベートグループビジネスキーに該当するプライベートグループ情報を取得します。
BizApiResultInfo listUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, String locale, Number [start], Number [count], Boolean [isDisable])
指定された条件を元に引数のプライベートグループに所属するユーザ情報について検索を行います。
BizApiResultInfo removePrivateGroup (PrivateGroupBizKeyInfo bizKey)
指定されたキーに対応するプライベートグループを削除します。
BizApiResultInfo removeUserAttach (PrivateGroupBizKeyInfo bizKey, UserBizKeyInfo userBizKey)
指定されたキーに対応するプライベートグループのユーザ所属情報をを削除します。
BizApiResultInfo searchPrivateGroup (AppCmnSearchCondition condition, Number [start], Number [count])
指定された条件を元にプライベートグループを検索します。
BizApiResultInfo searchUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, String locale, Number [start], Number [count], Boolean [isDisable])
指定された条件を元に引数のプライベートグループに所属するユーザ情報について検索を行います。
BizApiResultInfo setPrivateGroup (PrivateGroupInfo privateGroup)
プライベートグループ情報を新規登録、もしくは更新処理を行います。
BizApiResultInfo setUserAttach (PrivateGroupBizKeyInfo bizKey, UserBizKeyInfo userBizKey, String sortKey)
ユーザをプライベートグループに新規所属、もしくは更新処理を行います。
BizApiResultInfo totalUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, Boolean isDisable)
指定された条件を元に引数のプライベートグループに所属するユーザ数を取得します。

コンストラクタの詳細

IMMPrivateGroupManager (String [updateUserCd], String [defaultLocale])
コンストラクタ
パラメータ
[updateUserCd] : String
更新ユーザコード
[defaultLocale] : String
デフォルトロケール
IMMPrivateGroupManager (String updateUserCd, String defaultLocale, String loginGroupId) 非推奨
IMMPrivateGroupManager([String updateUserCd][,String defaultLocale])を使用してください。
コンストラクタ
パラメータ
updateUserCd : String
更新ユーザコード
defaultLocale : String
デフォルトロケール
loginGroupId : String
ログイングループID

メソッドの詳細

BizApiResultInfo countPrivateGroup (AppCmnSearchCondition condition)
指定された条件に該当するプライベートグループの個数を取得します。
conditionに指定できるテーブルは、imm_private_grpテーブルです。
パラメータ
condition : AppCmnSearchCondition
検索条件
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得したデータの件数(Number)が設定されます。
BizApiResultInfo countUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, String locale, Boolean isDisable)
指定された条件を元に引数のプライベートグループに所属するユーザ数を取得します。

conditionに指定できるテーブルは、imm_userテーブルです。
パラメータ
bizKey : PrivateGroupBizKeyInfo
取得対象となるユーザが所属するプライベートグループビジネスキーオブジェクト
condition : AppCmnSearchCondition
検索条件
date : Date
検索対象日付
locale : String
検索対象ロケール
isDisable : Boolean
このパラメータがfalseの場合は削除フラグが有効なレコードはカウントしません
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得したデータの件数(Number)が設定されます。
BizApiResultInfo getPrivateGroup (PrivateGroupBizKeyInfo bizKey)
引数のプライベートグループビジネスキーに該当するプライベートグループ情報を取得します。

取得するレコードがない場合はNULLが返されます。
パラメータ
bizKey : PrivateGroupBizKeyInfo
取得するプライベートグループビジネスキーオブジェクト
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに
プライベートグループ情報が設定されます。
BizApiResultInfo listUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, String locale, Number [start], Number [count], Boolean [isDisable])
指定された条件を元に引数のプライベートグループに所属するユーザ情報について検索を行います。

conditionに指定できるテーブルは、imm_userテーブルです。
パラメータ
bizKey : PrivateGroupBizKeyInfo
取得対象となるユーザが所属するプライベートグループビジネスキーオブジェクト
condition : AppCmnSearchCondition
検索条件
date : Date
検索対象日付
locale : String
検索対象ロケール
[start] : Number
取得開始レコード行。この引数を利用する場合は取得レコード数(count)を設定してください。
このパラメータが省略された場合、1(先頭行)が設定されます。
[count] : Number
取得レコード数。この引数を利用する場合は取得開始レコード行(start)を設定してください。
このパラメータが省略された場合、0(指定せず全件取得)が設定されます。
[isDisable] : Boolean
レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに
ユーザリスト情報の配列が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)
BizApiResultInfo removePrivateGroup (PrivateGroupBizKeyInfo bizKey)
指定されたキーに対応するプライベートグループを削除します。

実行されるリスナ
削除:
PrivateGroupListener#removePrivateGroup
パラメータ
bizKey : PrivateGroupBizKeyInfo
削除対象のプライベートグループビジネスキーオブジェクト
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。
BizApiResultInfo removeUserAttach (PrivateGroupBizKeyInfo bizKey, UserBizKeyInfo userBizKey)
指定されたキーに対応するプライベートグループのユーザ所属情報をを削除します。

実行されるリスナ
削除:
PrivateGroupListener#removeUserAttach
パラメータ
bizKey : PrivateGroupBizKeyInfo
削除する所属情報 - プライベートグループビジネスキーオブジェクト
userBizKey : UserBizKeyInfo
削除する所属情報 - ユーザビジネスキーオブジェクト
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。
BizApiResultInfo searchPrivateGroup (AppCmnSearchCondition condition, Number [start], Number [count])
指定された条件を元にプライベートグループを検索します。

取得するレコードが無い場合は空の配列が返されます。 conditionに指定できるテーブルは、imm_private_grpテーブルです。
パラメータ
condition : AppCmnSearchCondition
検索条件
[start] : Number
取得開始レコード行。この引数を利用する場合は取得レコード数(count)を設定してください。
このパラメータが省略された場合、1(先頭行)が設定されます。
[count] : Number
取得レコード数。この引数を利用する場合は取得開始レコード行(start)を設定してください。
このパラメータが省略された場合、0(指定せず全件取得)が設定されます。
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに
プライベートグループリスト情報の配列が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)
BizApiResultInfo searchUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, String locale, Number [start], Number [count], Boolean [isDisable])
指定された条件を元に引数のプライベートグループに所属するユーザ情報について検索を行います。

conditionに指定できるテーブルは、imm_userテーブルです。
パラメータ
bizKey : PrivateGroupBizKeyInfo
取得対象となるユーザが所属するプライベートグループビジネスキーオブジェクト
condition : AppCmnSearchCondition
検索条件
date : Date
検索対象日付
locale : String
検索対象ロケール
[start] : Number
取得開始レコード行。この引数を利用する場合は取得レコード数(count)を設定してください。
このパラメータが省略された場合、1(先頭行)が設定されます。
[count] : Number
取得レコード数。この引数を利用する場合は取得開始レコード行(start)を設定してください。
このパラメータが省略された場合、0(指定せず全件取得)が設定されます。
[isDisable] : Boolean
レコードの取得に関して、このパラメータがfalseの場合は削除フラグが有効なレコードは取得しません。
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに
ユーザリスト情報の配列が設定されます。
(該当データが存在しない場合は要素数 0 の Array が返却されます。)
BizApiResultInfo setPrivateGroup (PrivateGroupInfo privateGroup)
プライベートグループ情報を新規登録、もしくは更新処理を行います。

引数として与えられたプライベートグループ情報について、
存在しない場合は新たなプライベートグループ情報を登録します。
既に存在する場合は、更新処理をおこないます。

実行されるリスナ
作成:
PrivateGroupListener#createPrivateGroup
更新:
PrivateGroupListener#updatePrivateGroup
パラメータ
privateGroup : PrivateGroupInfo
プライベートグループ情報オブジェクト
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。
BizApiResultInfo setUserAttach (PrivateGroupBizKeyInfo bizKey, UserBizKeyInfo userBizKey, String sortKey)
ユーザをプライベートグループに新規所属、もしくは更新処理を行います。

引数として与えられたプライベートグループ所属情報について、
存在しない場合は新たな所属関係を付与します。
既に存在する場合は、更新処理をおこないます。

実行されるリスナ
作成:
PrivateGroupListener#createUserAttach
更新:
PrivateGroupListener#updateUserAttach
パラメータ
bizKey : PrivateGroupBizKeyInfo
処理を行う所属情報 - プライベートグループビジネスキーオブジェクト
userBizKey : UserBizKeyInfo
処理を行う所属情報 - ユーザビジネスキーオブジェクト
sortKey : String
ソートキー
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティにnullが設定されます。
BizApiResultInfo totalUserWithPrivateGroup (PrivateGroupBizKeyInfo bizKey, AppCmnSearchCondition condition, Date date, Boolean isDisable)
指定された条件を元に引数のプライベートグループに所属するユーザ数を取得します。

conditionに指定できるテーブルは、imm_userテーブルです。
パラメータ
bizKey : PrivateGroupBizKeyInfo
取得対象となるユーザが所属するプライベートグループビジネスキーオブジェクト
condition : AppCmnSearchCondition
検索条件
date : Date
検索対象日付
isDisable : Boolean
このパラメータがfalseの場合は削除フラグが有効なレコードはカウントしません
返却値
BizApiResultInfo
BizApiResultInfo 処理結果オブジェクト
処理結果オブジェクトのdataプロパティに取得したデータの件数(Number)が設定されます。