public class InvitationManager extends Object
コンストラクタと説明 |
---|
InvitationManager() |
修飾子とタイプ | メソッドと説明 |
---|---|
int |
countHistories(InvitationSetHistoryCondition condition)
招待履歴数をカウントします。
|
int |
countInvitationSets(InvitationSetCondition condition)
招待情報数をカウントします。
|
void |
deleteHistory(String invHistoryId)
招待履歴を削除します。
|
void |
deleteInvitationSet(String invSetId)
招待情報を削除します。
|
List<InvitationSetHistory> |
findHistories(int start,
int length,
InvitationSetHistoryCondition condition)
招待履歴を取得します。
|
InvitationSetHistory |
findHistory(String invHistoryId)
招待履歴を取得します。
|
InvitationSet |
findInvitationSet(String invSetId)
招待情報を取得します。
|
List<InvitationSet> |
findInvitationSets(int start,
int length,
InvitationSetCondition condition)
招待情報のリストを取得します。
|
List<InvitationDecoratorModel> |
getInvitationDecorators()
設定ファイルから招待権限デコレータを取得します。
|
InvitationMailInfo |
getMailInfo()
設定ファイルからデフォルトのメール設定を取得します。
|
void |
insertInvitationSet(InvitationSet set)
招待情報を新規登録します。
|
void |
invite(String invSetId,
String emailAddress,
String userCd)
指定した招待情報でメールアドレスのユーザの招待を行います。
|
void |
invite(String invSetId,
String emailAddress,
String userCd,
Locale locale)
指定した招待情報でメールアドレスのユーザの招待を行います。
|
void |
invite(String invSetId,
String emailAddress,
String userCd,
Locale locale,
Map<String,String> replacements)
指定した招待情報でメールアドレスのユーザの招待を行います。
|
boolean |
isAlreadyInvited(String invSetId,
String emailAddress)
すでに招待されているかどうかを返却します。
|
void |
registerUser(String invHistoryId,
String userName,
String password)
指定した履歴の招待情報にもとづき、ユーザを新規作成します。
|
void |
registerUser(String invHistoryId,
String userName,
String password,
String userCd)
指定した履歴の招待情報にもとづき、ユーザを新規作成します。
|
Set<String> |
searchExistUser(String emailAddress)
指定したメールアドレスをプロファイルに持つユーザのユーザコードのセットを返却します。
|
void |
updateHistoryStatus(String invHistoryId,
InvitationSetHistory.Status status)
招待履歴のステータスを更新します。
|
void |
updateInvitationSet(InvitationSet set)
招待情報を更新します。
|
void |
updateUser(String invHistoryId)
指定した招待情報にもとづき、既存のユーザに招待情報の持つ招待権限デコレータクラスを実行します。
|
public int countHistories(InvitationSetHistoryCondition condition) throws ExternalUserInvitationException
condition
- 招待履歴検索条件ExternalUserInvitationException
- 招待履歴数の取得に失敗した場合、または、引数が不正な場合にスローされます。public int countInvitationSets(InvitationSetCondition condition) throws ExternalUserInvitationException
condition
- 招待情報検索条件ExternalUserInvitationException
- 招待情報数の取得に失敗した場合、または、引数が不正な場合にスローされます。public void deleteHistory(String invHistoryId) throws ExternalUserInvitationException
invHistoryId
- 招待履歴IDExternalUserInvitationException
- 招待履歴の削除に失敗した場合、または、引数が不正な場合にスローされます。public void deleteInvitationSet(String invSetId) throws ExternalUserInvitationException
invSetId
- 招待情報IDExternalUserInvitationException
- 招待情報の削除に失敗した場合、または、引数が不正な場合にスローされます。public List<InvitationSetHistory> findHistories(int start, int length, InvitationSetHistoryCondition condition) throws ExternalUserInvitationException
start
- 取得開始行length
- 取得件数condition
- 招待履歴検索条件ExternalUserInvitationException
- 招待履歴の取得に失敗した場合、または、引数が不正な場合にスローされます。public InvitationSetHistory findHistory(String invHistoryId) throws ExternalUserInvitationException
invHistoryId
- ヒストリーIDExternalUserInvitationException
- 招待履歴の取得に失敗した場合、または、引数が不正な場合にスローされます。public InvitationSet findInvitationSet(String invSetId) throws ExternalUserInvitationException
invSetId
- 招待情報IDExternalUserInvitationException
- 招待情報の取得に失敗した場合、または、引数が不正な場合にスローされます。public List<InvitationSet> findInvitationSets(int start, int length, InvitationSetCondition condition) throws ExternalUserInvitationException
start
- 取得開始行length
- 取得件数condition
- 招待情報検索条件ExternalUserInvitationException
- 招待情報の取得に失敗した場合、または、引数が不正な場合にスローされます。public List<InvitationDecoratorModel> getInvitationDecorators() throws ExternalUserInvitationException
ExternalUserInvitationException
- 招待権限デコレータの取得に失敗した場合にスローされます。public InvitationMailInfo getMailInfo() throws ExternalUserInvitationException
ExternalUserInvitationException
- メール設定の取得に失敗した場合にスローされます。public void insertInvitationSet(InvitationSet set) throws ExternalUserInvitationException
set
- 招待情報ExternalUserInvitationException
- 招待情報の登録に失敗した場合、または、引数が不正な場合にスローされます。public void invite(String invSetId, String emailAddress, String userCd) throws ExternalUserInvitationException
invSetId
- 招待情報IDemailAddress
- メールアドレスuserCd
- 登録ユーザコードExternalUserInvitationException
- ユーザの招待に失敗した場合、または、引数が不正な場合にスローされます。public void invite(String invSetId, String emailAddress, String userCd, Locale locale) throws ExternalUserInvitationException
invSetId
- 招待情報IDemailAddress
- メールアドレスuserCd
- 登録ユーザコードlocale
- ロケールExternalUserInvitationException
- ユーザの招待に失敗した場合、または、引数が不正な場合にスローされます。public void invite(String invSetId, String emailAddress, String userCd, Locale locale, Map<String,String> replacements) throws ExternalUserInvitationException
{url}, {emailAddress}, {limit}
に加えて、テンプレートの追加置換文字列として指定された情報を元に招待メールの本文を生成します。invSetId
- 招待情報IDemailAddress
- メールアドレスuserCd
- 登録ユーザコードlocale
- ロケールreplacements
- テンプレートの追加置換文字列ExternalUserInvitationException
- ユーザの招待に失敗した場合、または、引数が不正な場合にスローされます。public boolean isAlreadyInvited(String invSetId, String emailAddress) throws ExternalUserInvitationException
invSetId
- 招待情報IDemailAddress
- メールアドレスExternalUserInvitationException
- 招待可能かどうかの取得に失敗した場合、または、引数が不正な場合にスローされます。public void registerUser(String invHistoryId, String userName, String password) throws ExternalUserInvitationException
invHistoryId
- 招待履歴IDuserName
- 名前password
- パスワードExternalUserInvitationException
- ユーザの作成に失敗した場合、または、引数が不正な場合にスローされます。public void registerUser(String invHistoryId, String userName, String password, String userCd) throws ExternalUserInvitationException
invHistoryId
- 招待履歴IDuserName
- 名前password
- パスワードuserCd
- ユーザコードExternalUserInvitationException
- ユーザの作成に失敗した場合、または、引数が不正な場合にスローされます。public Set<String> searchExistUser(String emailAddress) throws ExternalUserInvitationException
emailAddress
- メールアドレスExternalUserInvitationException
- 検索に失敗した場合、または、引数が不正な場合にスローされます。public void updateHistoryStatus(String invHistoryId, InvitationSetHistory.Status status) throws ExternalUserInvitationException
invHistoryId
- 招待履歴IDstatus
- ステータスExternalUserInvitationException
- 招待履歴の更新に失敗した場合、または、引数が不正な場合にスローされます。public void updateInvitationSet(InvitationSet set) throws ExternalUserInvitationException
set
- 招待情報ExternalUserInvitationException
- 招待情報の更新に失敗した場合、または、引数が不正な場合にスローされます。public void updateUser(String invHistoryId) throws ExternalUserInvitationException
invHistoryId
- 招待履歴IDExternalUserInvitationException
- ユーザの作成に失敗した場合、または、引数が不正な場合にスローされます。Copyright © 2012 NTT DATA INTRAMART CORPORATION