代理設定マネージャオブジェクト。
ユーザの代理情報の取得や登録、更新、削除処理を行ったり、指定したユーザが代理設定管理者であるかを判定します。
本オブジェクトでは、代理の設定情報を拡張ポイントIDとプラグインIDで管理する為に必要なメソッドを提供しています。
代理元や代理先等の展開された情報を取得するには「OriginalActList」や「TargetActList」を使用します。
関連オブジェクト:OriginalActList, TargetActList
導入されたバージョン:7.2
コンストラクタの概要 | |
ActConfig
|
メソッドの概要 | |
| createActConfig
|
| deleteActConfig
|
| getActConfig
|
| isActAuthorityUser
|
| updateActConfig
|
コンストラクタの詳細 |
コンストラクタ。
引数で指定したログイングループIDで代理設定マネージャを新しく生成します。
パラメータ
loginGroupId String ログイングループID
メソッドの詳細 |
| createActConfig
|
代理設定情報を新規登録します。
指定した「代理設定情報の配列」を代理設定情報テーブル「imw_t_act」に登録します。
登録する代理設定情報の配列は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
登録対象になる指定したパラメータの配列の件数と実際に成功した登録件数が異なる場合でも処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
データベースへの処理で失敗した場合ではエラー情報を格納した結果オブジェクトを返却します。
代理設定情報テーブルに登録した後、設定されたプラグイン情報を展開し、
代理設定一時展開テーブル「imw_t_act_temporary_expand」の情報も登録します。
代理設定通知メール送信フラグにTRUEを指定した場合、代理設定通知コメントで指定した
文字列を本文に含めた代理設定通知メールを送信します。
代理設定通知コメントのチェックは行ってません。設定したコメントがない場合は内容が空のメールが送信されます。
更新、削除処理は「updateActConfig(Array, Boolean, String)、 「deleteActConfig(Array)」を利用してください。
このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。
パラメータ
actConfig Array 代理設定情報オブジェクトの配列 sendMailFlg Boolean 代理設定通知メール送信フラグ noticeComment String 代理設定通知コメント
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。
| deleteActConfig
|
代理設定情報を削除します。
代理設定情報テーブル「imw_t_act」に対して削除処理を行います。
削除する代理設定情報の配列は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
指定した「代理設定情報の配列」モデルに設定された連番と代理元ユーザコードの値をキーにしてデータを削除します。
値を設定していない項目(nullの項目)は検索条件から除いて削除処理を行います。
ただし、2つ項目をNULLにしても全項目削除にはなりません。例外「WorkflowException」が発生します。
削除をする場合には、必ずひとつ以上の項目に値を設定する必要があります。
データベースへの処理で失敗した場合ではエラー情報を格納した結果オブジェクトを返却します。
削除については実際に削除されたデータが「1」件未満の場合でも正常終了になります。
登録、更新処理は「createActConfig(Array, Boolean, String)」、 「updateActConfig(Array, Boolean, String)」を利用してください。
このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。
パラメータ
actConfig Array 代理設定情報オブジェクトの配列
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。
| getActConfig
|
代理元ユーザに対して設定されている代理設定情報を取得します。
指定した「連番」と「代理元ユーザコード」をキーに「imw_t_act」テーブルの代理設定情報を取得します。
「連番」と「代理元ユーザコード」は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
取得データが存在しない場合はdata属性に「null」を設定して返却します。
引数の連番は「OriginalActList」や「TargetActList」から取得できます。
パラメータ
no String 連番 originalActUserCode String 代理元ユーザコード
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、代理設定情報オブジェクトが設定されます。
| isActAuthorityUser
|
指定したユーザが代理設定管理者であるかを判定します。
代理管理者設定テーブル「imw_m_act_administration」に指定したユーザが設定されているかを判定します。
テーブルに設定されている全ての拡張ポイントID、プラグインID、パラメータに該当するユーザを展開し、
その中に引数で指定したユーザコードが存在するかを判定します。
対象ユーザコードは必須になります。設定されてない場合は例外処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
パラメータ
userCd String 対象ユーザコード
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、代理設定管理者判定結果(true:代理設定管理者 / false:代理設定管理者対象外)(Boolean)が設定されます。
| updateActConfig
|
代理設定情報を更新します。
代理設定情報テーブル「imw_t_act」に対して更新処理を行います。
更新する代理設定情報の配列は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
指定した「代理設定情報の配列」モデルで「連番」と「代理元ユーザコード」をキーにして、キー以外に設定されている値を更新します。
値を設定していない項目(nullの項目)は更新対象外になります。
データベース更新処理後、実際に更新されたデータが「1」件未満の場合でも処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
データベースへの処理で失敗した場合ではエラー情報を格納した結果オブジェクトを返却します。
代理設定情報テーブルを更新した後、更新されたプラグイン情報を展開し、
代理設定一時展開テーブル「imw_t_act_temporary_expand」の情報も更新します。
更新処理では既存データを全削除し、新データを追加します。
代理設定通知メール送信フラグにTRUEを指定した場合、代理設定通知コメントで指定した
文字列を本文に含めた代理設定通知メールを送信します。
代理設定通知コメントのチェックは行ってません。設定したコメントがない場合は内容が空のメールが送信されます。
登録、削除処理は「createActConfig(Array, Boolean, String)」、 「deleteActConfig(Array)」を利用してください。
このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。
パラメータ
actConfig Array 代理設定情報オブジェクトの配列 sendMailFlg Boolean 代理設定通知メール送信フラグ noticeComment String 代理設定通知コメント
返却値
WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。