imbox.MylistOperationsオブジェクト

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

コンポーネント概要

マイリストに対する操作を行うクラスです。

メソッドの概要

返却値の型	メソッド名
ResultObject	addUser (MylistKey `mylistKey`, Array `userCds`) マイリストにユーザの追加を行います。
ResultObject	create (String `mylistName`) マイリストの作成を行います。
ResultObject	edit (Entry4Mylist `entry4Mylist`) マイリスト名の編集を行います。
ResultObject	existsMylist (String `mylistId`) マイリストの存在有無の判定を行います。
ResultObject	getMylistMembersWithCheckDeleteFlag (MylistKey `mylistKey`, String `start`, Boolean `deleteFlag`) マイリスト所属ユーザ一覧の取得を行います。
ResultObject	getMylistMembers (MylistKey `mylistKey`, String `start`) マイリスト所属ユーザ一覧の取得を行います。
ResultObject	getMylistMembers (MylistKey `mylistKey`, String `start`, Number `count`) マイリスト所属ユーザ一覧の取得を行います。
ResultObject	getMylistMembers (MylistKey `mylistKey`, String `start`, Number `count`, Boolean `deleteFlag`) マイリスト所属ユーザ一覧の取得を行います。
ResultObject	getMylist (MylistKey `mylistKey`) 指定したマイリストの取得を行います。
ResultObject	getMylists (String `start`) 作成したマイリスト一覧の取得を行います。
ResultObject	isMember (String `mylistId`, String `userCd`) マイリストのメンバーであるかの判定を行います。
ResultObject	removeUser (MylistKey `mylistKey`, Array `userCds`) マイリストからユーザの削除を行います。
ResultObject	remove (String `mylistId`) マイリストの削除を行います。

メソッドの詳細

ResultObject addUser (MylistKey mylistKey, Array userCds)

マイリストにユーザの追加を行います。

パラメータ

mylistKey : MylistKey: マイリストキー

userCds : Array: マイリストに追加するユーザのユーザコード(複数指定可能)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject create (String mylistName)

マイリストの作成を行います。

パラメータ

mylistName : String: マイリスト情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、マイリストキー情報が設定されます。
data プロパティの取得結果が存在しない場合は、nullが返却されます。

ResultObject edit (Entry4Mylist entry4Mylist)

マイリスト名の編集を行います。

パラメータ

entry4Mylist : Entry4Mylist: マイリスト登録情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject existsMylist (String mylistId)

マイリストの存在有無の判定を行います。
削除フラグのONの場合は存在していないと判定されます。

パラメータ

mylistId : String: マイリストID

返却値

ResultObject: ResultObject 処理結果
data プロパティには、マイリストが存在する場合は true、それ以外は false が設定されます。

ResultObject getMylistMembersWithCheckDeleteFlag (MylistKey mylistKey, String start, Boolean deleteFlag)

マイリスト所属ユーザ一覧の取得を行います。
引数ユーザコード（start）を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード（start）にnullを指定した場合は先頭のユーザから返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ

mylistKey : MylistKey: マイリストキー情報

start : String: ユーザコード

deleteFlag : Boolean: 削除フラグ true:論理削除されているユーザも取得します。/false：論理削除されているユーザの取得は行いません。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getMylistMembers (MylistKey mylistKey, String start)

パラメータ

mylistKey : MylistKey: マイリストキー情報

start : String: ユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getMylistMembers (MylistKey mylistKey, String start, Number count)

マイリスト所属ユーザ一覧の取得を行います。
引数countに指定した件数分のユーザを取得します。
引数ユーザコード（start）を指定することにより、そのユーザコード以降のユーザ情報が返却されます。
引数ユーザコード（start）にnullを指定した場合は先頭のユーザから返却されます。
取得件数は、countに設定された件数分のみ取得が行われます。
論理削除されているユーザの取得は行いません。

パラメータ

mylistKey : MylistKey: マイリストキー情報

start : String: ユーザコード

count : Number: 取得件数

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getMylistMembers (MylistKey mylistKey, String start, Number count, Boolean deleteFlag)

パラメータ

mylistKey : MylistKey: マイリストキー情報

start : String: ユーザコード

count : Number: 取得件数

deleteFlag : Boolean: 削除フラグ true:論理削除されているユーザも取得します。/false：論理削除されているユーザの取得は行いません。

返却値

ResultObject: ResultObject 処理結果
data プロパティには、ユーザ情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject getMylist (MylistKey mylistKey)

指定したマイリストの取得を行います。

パラメータ

mylistKey : MylistKey: マイリストキー情報

返却値

ResultObject: ResultObject 処理結果
data プロパティには、マイリスト情報が設定されます。
data プロパティの取得結果が存在しない場合は、nullが返却されます。

ResultObject getMylists (String start)

作成したマイリスト一覧の取得を行います。
引数マイリストID（start）を指定することにより、そのマイリストID以降のマイリスト情報が返却されます。
引数マイリストID（start）にnullを指定した場合は先頭のマイリスト情報から返却されます。
取得件数は、imbox-config.xmlに設定された件数分のみ取得が行われます。（デフォルトは20件）

パラメータ

start : String: マイリストID

返却値

ResultObject: ResultObject 処理結果
data プロパティには、マイリスト情報リストが設定されます。
data プロパティの取得結果が存在しない場合は、空の配列、エラーの場合はnullが返却されます。

ResultObject isMember (String mylistId, String userCd)

マイリストのメンバーであるかの判定を行います。

パラメータ

mylistId : String: 判定対象マイリストのマイリストID

userCd : String: 判判定対象ユーザのユーザコード

返却値

ResultObject: ResultObject 処理結果
data プロパティには、マイリストのメンバーである場合は true、それ以外は false が設定されます。

ResultObject removeUser (MylistKey mylistKey, Array userCds)

マイリストからユーザの削除を行います。

パラメータ

mylistKey : MylistKey: マイリストキー情報

userCds : Array: マイリストから削除したいユーザのユーザコード(複数指定可能)

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。

ResultObject remove (String mylistId)

マイリストの削除を行います。

パラメータ

mylistId : String: マイリストID

返却値

ResultObject: ResultObject 処理結果
data プロパティには、nullが設定されます。