jp.co.intra_mart.foundation.master.user

インタフェース UserWriter

public interface UserWriter

ユーザ情報の管理メソッドを定義するインターフェース

導入されたバージョン:

7.2

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ProvideListenerModel	mergeBackwardTermUser(IAppCmnInfo info, IUserBizKey bizKey, String termCd) 指定したユーザの期間を、直前の期間と結合します。
ProvideListenerModel	mergeForwardTermUser(IAppCmnInfo info, IUserBizKey bizKey, String termCd) 指定したユーザの期間を、直後の期間と結合します。
ProvideListenerModel	moveTermUser(IAppCmnInfo info, IUserBizKey bizKey, ITerm term) ユーザの期間を変更します。
ProvideListenerRemoveKeyModel<IUserBizKey>	removeUser(IAppCmnInfo info, IUserBizKey bizKey, Locale locale) ユーザ情報を削除します。
ProvideListenerRemoveKeyModel<IUserCtgBizKey>	removeUserCategory(IAppCmnInfo info, IUserCtgBizKey bizKey, Locale locale) 分類区分を削除します。
ProvideListenerRemoveKeyModel<IUserCtgItmBizKey>	removeUserCategoryItem(IAppCmnInfo info, IUserCtgItmBizKey bizKey, Locale locale) ユーザ分類区分項目を削除します。
void	removeUserCategoryItemAttach(IAppCmnInfo info, IUserBizKey userBizKey, IUserCtgItmBizKey itemBizKey, String termCd) ユーザ分類区分項目のユーザに対する所属情報を削除します。
ProvideListenerModel	separateTermUser(IAppCmnInfo info, IUserBizKey bizKey, String termCd, Date date) ユーザの期間を分割します。
ITerm[]	setUser(IAppCmnInfo info, User user) ユーザを登録します。
UserCtg	setUserCategory(IAppCmnInfo info, UserCtg userCategory) ユーザ分類区分を登録します。
UserCtgItm	setUserCategoryItem(IAppCmnInfo info, UserCtgItm userCategoryItem) ユーザ分類区分項目を登録します。
ITerm[]	setUserCategoryItemAttach(IAppCmnInfo info, IUserBizKey userBizKey, IUserCtgItmBizKey itemBizKey, ITerm term) ユーザ分類区分項目の所属を登録します。

メソッドの詳細

mergeBackwardTermUser

ProvideListenerModel mergeBackwardTermUser(IAppCmnInfo info,
                                           IUserBizKey bizKey,
                                           String termCd)
                                    throws BizApiException

指定したユーザの期間を、直前の期間と結合します。
直前の期間で登録されているデータは失われます。

パラメータ:

info - 基本情報

bizKey - ユーザビジネスキー郡

termCd - 期間コード

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

mergeForwardTermUser

ProvideListenerModel mergeForwardTermUser(IAppCmnInfo info,
                                          IUserBizKey bizKey,
                                          String termCd)
                                   throws BizApiException

指定したユーザの期間を、直後の期間と結合します。
直後の期間で登録されているデータは失われます。

パラメータ:

info - 基本情報

bizKey - ユーザビジネスキー郡

termCd - 期間コード

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

moveTermUser

ProvideListenerModel moveTermUser(IAppCmnInfo info,
                                  IUserBizKey bizKey,
                                  ITerm term)
                           throws BizApiException

ユーザの期間を変更します。
更新後の期間情報が前後の期間と重複する場合、前後の期間が短縮されます。ある期間と完全に重複する場合はその期間情報は削除されます。
前後の期間と間隔ができる場合は、前後の期間が延長されます。
ただし、変更しようとしている期間の開始/終了日がシステム開始/終了日である場合は新しい期間が作成されます。

パラメータ:

info - 基本情報

bizKey - ユーザビジネスキー郡

term - 期間情報

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

removeUserCategoryItemAttach

void removeUserCategoryItemAttach(IAppCmnInfo info,
                                  IUserBizKey userBizKey,
                                  IUserCtgItmBizKey itemBizKey,
                                  String termCd)
                           throws BizApiException

ユーザ分類区分項目のユーザに対する所属情報を削除します。

パラメータ:

info - 基本情報

userBizKey - ユーザビジネスキー郡

itemBizKey - ユーザ分類区分ビジネスキー郡

termCd -

例外:

BizApiException

removeUser

ProvideListenerRemoveKeyModel<IUserBizKey> removeUser(IAppCmnInfo info,
                                                      IUserBizKey bizKey,
                                                      Locale locale)
                                               throws BizApiException

ユーザ情報を削除します。

ロケールを指定した場合はその言語のみが削除されます。
削除する言語を指定しなかった場合は、全言語のデータが削除されます。
すべての国際化情報が削除されると関連情報がすべて削除されます。

パラメータ:

info - 基本情報

bizKey - ユーザビジネスキー郡

locale - 削除する言語 nullを指定した場合は全言語のデータを削除します。

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

removeUserCategory

ProvideListenerRemoveKeyModel<IUserCtgBizKey> removeUserCategory(IAppCmnInfo info,
                                                                 IUserCtgBizKey bizKey,
                                                                 Locale locale)
                                                          throws BizApiException

分類区分を削除します。

ロケールを指定した場合はその言語のみが削除されます。
削除する言語を指定しなかった場合は、全言語のデータが削除されます。
すべての国際化情報が削除されると関連情報がすべて削除されます。

パラメータ:

info - 基本情報

bizKey - ユーザ分類区分ビジネスキー郡

locale - 削除する言語

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

removeUserCategoryItem

ProvideListenerRemoveKeyModel<IUserCtgItmBizKey> removeUserCategoryItem(IAppCmnInfo info,
                                                                        IUserCtgItmBizKey bizKey,
                                                                        Locale locale)
                                                                 throws BizApiException

ユーザ分類区分項目を削除します。

ロケールを指定した場合はその言語のみが削除されます。
削除する言語を指定しなかった場合は、全言語のデータが削除されます。
すべての国際化情報が削除されると関連情報がすべて削除されます。

パラメータ:

info - 基本情報

bizKey - 分類区分項目ビジネスキー郡

locale - 削除する言語

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

separateTermUser

ProvideListenerModel separateTermUser(IAppCmnInfo info,
                                      IUserBizKey bizKey,
                                      String termCd,
                                      Date date)
                               throws BizApiException

ユーザの期間を分割します。
分割前の期間コードは分割日より前の期間が引き継ぎます。分割日より後の期間には新しい期間コードが割り当てられます。期間コード以外の情報は分割前のデータを引き継ぎます。

パラメータ:

info - 基本情報

bizKey - ユーザビジネスキー郡

termCd - 分割する期間の期間コード

date - 分割日

戻り値:

リスナーへのデータ供給モデル

例外:

BizApiException

setUserCategoryItemAttach

ITerm[] setUserCategoryItemAttach(IAppCmnInfo info,
                                  IUserBizKey userBizKey,
                                  IUserCtgItmBizKey itemBizKey,
                                  ITerm term)
                           throws BizApiException

ユーザ分類区分項目の所属を登録します。すでに登録されている場合は更新されます。

パラメータ:

info - 基本情報

userBizKey - ユーザビジネスキー郡

itemBizKey - 分類区分項目ビジネスキー郡

term - 期間情報

戻り値:

新規登録された期間情報リスト

例外:

BizApiException

setUser

ITerm[] setUser(IAppCmnInfo info,
                User user)
         throws BizApiException

ユーザを登録します。すでに登録されている場合は更新されます。
このメソッドで期間は変更できません。

パラメータ:

info - 基本情報

user - ユーザ情報

戻り値:

新規登録された期間情報リスト

例外:

BizApiException

setUserCategory

UserCtg setUserCategory(IAppCmnInfo info,
                        UserCtg userCategory)
                 throws BizApiException

ユーザ分類区分を登録します。すでに登録されている場合は更新されます。

パラメータ:

info - 基本情報

userCategory - ユーザ分類区分情報

戻り値:

リ新規登録されたユーザ分類区分情報。更新の場合はnull

例外:

BizApiException

setUserCategoryItem

UserCtgItm setUserCategoryItem(IAppCmnInfo info,
                               UserCtgItm userCategoryItem)
                        throws BizApiException

ユーザ分類区分項目を登録します。すでに登録されている場合は更新されます。

パラメータ:

info - 基本情報

userCategoryItem - ユーザ分類区分項目

戻り値:

新規登録されたユーザ分類区分項目情報。更新の場合はnull

例外:

BizApiException