jp.co.intra_mart.foundation.workflow.application.process

クラス TempSaveManager

java.lang.Object

jp.co.intra_mart.system.workflow.common.AbstractBase

jp.co.intra_mart.foundation.workflow.application.process.TempSaveManager

public class TempSaveManager
extends jp.co.intra_mart.system.workflow.common.AbstractBase

一時保存マネージャ

一時保存案件を新規作成、更新、削除処理ができます。

このクラスでは、データベーステーブル「imw_t_temporary_save」への処理を行なっています。
新規作成、更新、削除の各処理を実行する際に、処理対象フローの申請ノードに指定したアクション処理が実行されます。
詳細は各メソッドの説明を参照してください。

導入されたバージョン:

7.2

バージョン:

8.0.21

フィールドのサマリー

クラスから継承されたフィールド jp.co.intra_mart.system.workflow.common.AbstractBase

localeId, loginGroupId

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TempSaveManager() コンストラクタ 一時保存マネージャを新しく生成します。
TempSaveManager(String localeId) コンストラクタ 引数で指定したロケールIDで一時保存マネージャを新しく生成します。
TempSaveManager(String loginGroupId, String localeId) 非推奨です。 TempSaveManager(String) を使用してください。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	createTempSaveMatter(TempSaveParam tempSaveParam, Map<String,Object> userParam) 一時保存案件を新規作成します。
void	deleteTempSaveMatter(TempSaveParam tempSaveParam, Map<String,Object> userParam) 一時保存案件を削除します。
void	updateTempSaveMatter(TempSaveParam tempSaveParam, Map<String,Object> userParam) 一時保存案件を更新します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

TempSaveManager

public TempSaveManager()

コンストラクタ
一時保存マネージャを新しく生成します。

TempSaveManager

public TempSaveManager(String localeId)

コンストラクタ
引数で指定したロケールIDで一時保存マネージャを新しく生成します。

パラメータ:

localeId - ロケールID

TempSaveManager

public TempSaveManager(String loginGroupId,
                       String localeId)

非推奨です。 TempSaveManager(String) を使用してください。

コンストラクタ
引数で指定したログイングループID、ロケールIDで一時保存マネージャを新しく生成します。

パラメータ:

loginGroupId - ログイングループID

localeId - ロケールID

メソッドの詳細

createTempSaveMatter

public void createTempSaveMatter(TempSaveParam tempSaveParam,
                                 Map<String,Object> userParam)
                          throws WorkflowException

一時保存案件を新規作成します。

このメソッドでは内部でトランザクションの制御処理を行なっています。
メソッドの実行前に、ユーザトランザクションを終了状態にして置く必要があります。

一時保存案件の作成処理を行う際に、対象のフローの申請ノードに設定されているアクション処理が実行されます。
アクション処理は、データベースに一時保存データを登録する前に実行されます。

アクション処理で実行される外部プログルムでのデータベースへの登録処理等もこのメソッド内の一時保存案件データ登録処理と同じトランザクション処理になります。
アクション処理の実行や、一時保存データの登録処理が全て正常に終了しない場合には、登録した全データがロールバックされて、「WorkflowException」が発生します。

「tempSaveParam 一時保存用パラメータ情報」には一時保存案件用の登録データを指定します。
このモデルのデータは「imw_t_temporary_save」テーブルに登録されます。
各項目の必須有無の詳細は「TempSaveParam」を参照してください。

アクション処理にはパラメータで設定した「userParam ユーザパラメータ」がそのまま渡されます。
アクション処理に渡したいデータがある場合はこのパラメータを利用してください。このパラメータの主な想定用途は、クライアントサイド入力情報のサーバサイドへの受け渡しです。

データベースへの登録処理や、トランザクションの制御処理で失敗した場合は、「WorkflowException」が発生します。

一時保存案件データの更新や削除処理は、「updateTempSaveMatter(TempSaveParam, Map)」、「deleteTempSaveMatter(TempSaveParam, Map)」を利用してください。

パラメータ:

tempSaveParam - 一時保存用パラメータ情報

userParam - ユーザパラメータ

例外:

WorkflowException - ワークフロー例外の親クラス

updateTempSaveMatter

public void updateTempSaveMatter(TempSaveParam tempSaveParam,
                                 Map<String,Object> userParam)
                          throws WorkflowException

一時保存案件を更新します。

このメソッドでは内部でトランザクションの制御処理を行なっています。
メソッドの実行前に、ユーザトランザクションを終了状態にして置く必要があります。

一時保存案件の更新処理を行う際に、対象のフローの申請ノードに設定されているアクション処理が実行されます。
アクション処理の実行は、データベースの一時保存データを更新する前に行います。

アクション処理で実行される外部プログルムでのデータベースへの登録処理等もこのメソッド内の一時保存案件データ更新処理と同じトランザクション処理になります。
アクション処理の実行や、一時保存データの更新処理が全て正常に終了しない場合には、更新した全データがロールバックされて、「WorkflowException」が発生します。

「tempSaveParam 一時保存用パラメータ情報」には一時保存案件用の更新データを指定します。
このモデルのデータは「imw_t_temporary_save」テーブルに更新されます。
各項目の必須有無の詳細は「TempSaveParam」を参照してください。
更新処理は、一時保存案件のテーブルへ「tempSaveParam 一時保存用パラメータ情報」の「ユーザデータID」をキーにして、
他にパラメータに設定された値の更新処理になります。
パラメータの項目の中で、値が設定されてない項目は更新対象外になります。「null」に項目を更新するのはできません。
尚、tempSaveParam 一時保存用パラメータ情報」の「ユーザデータID」には既に存在するユーザデータIDを指定する必要があります。
一時保存案件データとして登録されているデータの中に、同じ「ユーザデータID」が存在しなくて、更新処理が行なってなかった場合には、「WorkflowException」が発生します。

アクション処理にはパラメータで設定した「userParam ユーザパラメータ」がそのまま渡されます。
アクション処理に渡したいデータがある場合はこのパラメータを利用してください。このパラメータの主な想定用途は、クライアントサイド入力情報のサーバサイドへの受け渡しです。

データベースへの更新処理や、トランザクションの制御処理で失敗した場合には「WorkflowException」が発生します。

一時保存案件データの新規作成や削除処理は、「createTempSaveMatter(TempSaveParam, Map)」、「deleteTempSaveMatter(TempSaveParam, Map)」を利用してください。

パラメータ:

tempSaveParam - 一時保存用パラメータ情報

userParam - ユーザパラメータ

例外:

WorkflowException - ワークフロー例外の親クラス

deleteTempSaveMatter

public void deleteTempSaveMatter(TempSaveParam tempSaveParam,
                                 Map<String,Object> userParam)
                          throws WorkflowException

一時保存案件を削除します。

一時保存案件に紐付くユーザデータ案件プロパティは削除されません。
このメソッドでは内部でトランザクションの制御処理を行なっています。
メソッドの実行前に、ユーザトランザクションを終了状態にして置く必要があります。

一時保存案件の削除処理を行う際に、対象のフローの申請ノードに設定されているアクション処理が実行されます。
アクション処理の実行は、データベースの一時保存データを削除する前に行います。

アクション処理で実行される外部プログルムでのデータベースへの登録処理等もこのメソッド内の一時保存案件データ削除処理と同じトランザクション処理になります。
アクション処理の実行や、一時保存データの削除処理が全て正常に終了しない場合には、更新した全データがロールバックされて、「WorkflowException」が発生します。

「tempSaveParam 一時保存用パラメータ情報」には一時保存案件用の削除データを指定します。
設定したモデルで「imw_t_temporary_save」テーブルのデータを削除します。
各項目の必須有無の詳細は「TempSaveParam」を参照してください。
削除処理は、一時保存案件のテーブルへ「tempSaveParam 一時保存用パラメータ情報」の「ユーザデータID」をキーにして、
該当のデータの削除処理になります。
パラメータの「ユーザデータID」項目以外のデータは設定しても無視されます。
尚、tempSaveParam 一時保存用パラメータ情報」の「ユーザデータID」が既に存在しない場合で、削除処理が「０」件実行された場合でもエラーにはなりません。
正常終了になります。

アクション処理にはパラメータで設定した「userParam ユーザパラメータ」がそのまま渡されます。
アクション処理に渡したいデータがある場合はこのパラメータを利用してください。このパラメータの主な想定用途は、クライアントサイド入力情報のサーバサイドへの受け渡しです。

データベースへの削除処理や、トランザクションの制御処理で失敗した場合には「WorkflowException」が発生します。

一時保存案件データの新規作成や更新処理は、「createTempSaveMatter(TempSaveParam, Map)」、「updateTempSaveMatter(TempSaveParam, Map)」を利用してください。

パラメータ:

tempSaveParam - 一時保存用パラメータ情報

userParam - ユーザパラメータ

例外:

WorkflowException - ワークフロー例外の親クラス