コンストラクタの概要
InvitationManager () コンストラクタ。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | countHistories (InvitationSetHistoryCondition condition ) 招待履歴数をカウントします。 |
ResultObject | countInvitationSets (InvitationSetCondition condition ) 招待情報数をカウントします。 |
ResultObject | deleteHistory (String invHistoryId ) 招待履歴を削除します。 |
ResultObject | deleteInvitationSet (String invSetId ) 招待情報を削除します。 |
ResultObject | findHistories (Number [start] , Number [length] , InvitationSetHistoryCondition condition ) 招待履歴を取得します。 |
ResultObject | findHistory (String invHistoryId ) 招待履歴を取得します。 |
ResultObject | findInvitationSet (String invSetId ) 招待情報を取得します。 |
ResultObject | findInvitationSets (Number [start] , Number [length] , InvitationSetCondition condition ) 招待情報のリストを取得します。 |
ResultObject | getInvitationDecorators () 設定ファイルから招待権限デコレータを取得します。 |
ResultObject | getMailInfo () 設定ファイルからデフォルトのメール設定を取得します。 |
ResultObject | insertInvitationSet (InvitationSet set ) 招待情報を新規登録します。 |
ResultObject | invite (String invSetId , String emailAddress , String userCd ) 指定した招待情報でメールアドレスのユーザの招待を行います。 |
ResultObject | invite (String invSetId , String emailAddress , String userCd , String locale ) 指定した招待情報でメールアドレスのユーザの招待を行います。 |
ResultObject | invite (String invSetId , String emailAddress , String userCd , String locale , String replacements ) 指定した招待情報でメールアドレスのユーザの招待を行います。 |
ResultObject | isAlreadyInvited (String invSetId , String emailAddress ) すでに招待されているかどうかを返却します。 |
ResultObject | isCreateInvitationSet () 認可から招待情報を作成できるかどうかを判定します。 |
ResultObject | isEditAllInvitationSet () 認可から招待情報をすべて編集できるかどうかを判定します。 |
ResultObject | isEditInvitationSet (String invSetId ) 認可から招待情報を編集できるかどうかを判定します。 |
ResultObject | isInvite (String invSetId ) 認可から招待できるかを判定します。 |
ResultObject | registerUser (String invHistoryId , String userName , String password ) 指定した履歴の招待情報にもとづき、ユーザを新規作成します。 |
ResultObject | registerUser (String invHistoryId , String userName , String password , String userCd ) 指定した履歴の招待情報にもとづき、ユーザを新規作成します。 |
ResultObject | searchExistUser (String emailAddress ) 指定したメールアドレスをプロファイルに持つユーザのユーザコードの配列を返却します。 |
ResultObject | updateHistoryStatus (String invHistoryId , String status ) 招待履歴のステータスを更新します。 |
ResultObject | updateInvitationSet (InvitationSet set ) 招待情報を更新します。 |
ResultObject | updateUser (String invHistoryId ) 指定した招待情報にもとづき、既存のユーザに招待情報の持つ招待権限デコレータクラスを実行します。 |
コンストラクタの詳細
InvitationManager ()
コンストラクタ。
|
メソッドの詳細
ResultObject countHistories (InvitationSetHistoryCondition condition )
招待履歴数をカウントします。
また、取得前に「期限切れ」の履歴がある場合はステータスを更新します。
パラメータ
返却値
|
ResultObject countInvitationSets (InvitationSetCondition condition )
招待情報数をカウントします。
パラメータ
返却値
|
ResultObject deleteHistory (String invHistoryId )
招待履歴を削除します。
パラメータ
返却値
|
ResultObject deleteInvitationSet (String invSetId )
招待情報を削除します。
パラメータ
返却値
|
ResultObject findHistories (Number [start] , Number [length] , InvitationSetHistoryCondition condition )
招待履歴を取得します。
また、取得前に「期限切れ」の履歴がある場合はステータスを更新します。
パラメータ
返却値
|
ResultObject findHistory (String invHistoryId )
招待履歴を取得します。
また、取得前に「期限切れ」の履歴がある場合はステータスを更新します。
パラメータ
返却値
|
ResultObject findInvitationSet (String invSetId )
招待情報を取得します。
パラメータ
返却値
|
ResultObject findInvitationSets (Number [start] , Number [length] , InvitationSetCondition condition )
招待情報のリストを取得します。
パラメータ
返却値
|
ResultObject getInvitationDecorators ()
設定ファイルから招待権限デコレータを取得します。
返却値
|
ResultObject getMailInfo ()
設定ファイルからデフォルトのメール設定を取得します。
返却値
|
ResultObject insertInvitationSet (InvitationSet set )
招待情報を新規登録します。
パラメータ
返却値
|
ResultObject invite (String invSetId , String emailAddress , String userCd )
指定した招待情報でメールアドレスのユーザの招待を行います。
招待メールには指定したテナントのデフォルトロケールのテンプレートを利用します。
パラメータ
返却値
|
ResultObject invite (String invSetId , String emailAddress , String userCd , String locale )
指定した招待情報でメールアドレスのユーザの招待を行います。
招待メールには指定したロケールのテンプレートを利用します。
パラメータ
返却値
|
ResultObject invite (String invSetId , String emailAddress , String userCd , String locale , String replacements )
指定した招待情報でメールアドレスのユーザの招待を行います。
招待メールには指定したロケールのテンプレートを利用します。
パラメータ
返却値
|
ResultObject isAlreadyInvited (String invSetId , String emailAddress )
すでに招待されているかどうかを返却します。
招待情報の有効状態に関わらず、以下の場合はtrueを返却します。 同一の招待情報内で、招待期限を迎えていない「招待」状態の履歴が存在する場合 同一の招待情報内で、「登録済み」状態の履歴が存在する場合
パラメータ
返却値
|
ResultObject isCreateInvitationSet ()
認可から招待情報を作成できるかどうかを判定します。
返却値
|
ResultObject isEditAllInvitationSet ()
認可から招待情報をすべて編集できるかどうかを判定します。
返却値
|
ResultObject isEditInvitationSet (String invSetId )
認可から招待情報を編集できるかどうかを判定します。
パラメータ
返却値
|
ResultObject isInvite (String invSetId )
認可から招待できるかを判定します。
パラメータ
返却値
|
ResultObject registerUser (String invHistoryId , String userName , String password )
指定した履歴の招待情報にもとづき、ユーザを新規作成します。
このメソッドでは以下が行われます。
パラメータ
返却値
|
ResultObject registerUser (String invHistoryId , String userName , String password , String userCd )
指定した履歴の招待情報にもとづき、ユーザを新規作成します。
このメソッドでは以下が行われます。
パラメータ
返却値
|
ResultObject searchExistUser (String emailAddress )
指定したメールアドレスをプロファイルに持つユーザのユーザコードの配列を返却します。
パラメータ
返却値
|
ResultObject updateHistoryStatus (String invHistoryId , String status )
招待履歴のステータスを更新します。
パラメータ
返却値
|
ResultObject updateInvitationSet (InvitationSet set )
招待情報を更新します。
パラメータ
返却値
|
ResultObject updateUser (String invHistoryId )
指定した招待情報にもとづき、既存のユーザに招待情報の持つ招待権限デコレータクラスを実行します。
パラメータ
返却値
|