IM-Workflow

jp.co.intra_mart.foundation.workflow.application.general
クラス UserCplMatterPropertyValue

java.lang.Object
  上位を拡張 jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase
      上位を拡張 jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase
          上位を拡張 jp.co.intra_mart.foundation.workflow.application.general.UserCplMatterPropertyValue

public class UserCplMatterPropertyValue
extends jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase

完了案件のユーザデータ案件プロパティ情報マネージャ。

完了案件で利用するユーザデータ案件プロパティ情報の新規登録、更新、削除、検索処理を行います。
本クラスではユーザデータIDをキーで検索や更新処理を行います。検索や更新処理の対象になるテーブルは完了案件関連テーブルである「imw_t_cpl_matter_user_data」です。

処理中の未完了案件や過去案件のユーザデータプロパティ情報の操作には「UserActvMatterPropertyValue」、「UserArcMatterPropertyValue」を利用してください。

システム案件IDをキーで完了案件情報からユーザデータ案件プロパティ情報を取得するには、「CplMatter」を利用してください。

導入されたバージョン:
7.2
関連項目:
UserActvMatterPropertyValue, UserArcMatterPropertyValue, CplMatter

入れ子のクラスの概要
 
クラス jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase から継承された入れ子のクラス/インタフェース
jp.co.intra_mart.system.workflow.api.database.AbstractListDaoBase.SubSearchSql
 
フィールドの概要
 
クラス jp.co.intra_mart.system.workflow.engine.database.WorkflowDAOBase から継承されたフィールド
manager
 
コンストラクタの概要
UserCplMatterPropertyValue(String loginGroupId)
          コンストラクタ
引数で指定したログイングループIDでユーザデータ案件プロパティ情報(完了案件)マネージャを新しく生成します。
 
メソッドの概要
 void createMatterProperty(UserMatterPropertyModel[] matterProperty)
          完了案件のユーザデータ案件プロパティ情報を新規登録します。
 void deleteMatterProperty(UserMatterPropertyModel[] matterProperty)
          完了案件のユーザデータ案件プロパティ情報を削除します。
 UserMatterPropertyModel getMatterProperty(String userDataId, String key)
          完了案件の特定のユーザデータ案件プロパティ情報を取得します。
 UserMatterPropertyModel[] getMatterPropertyList(String userDataId)
          完了案件のユーザデータ案件プロパティ情報をすべて取得します。
 int getMatterPropertyListCount(String userDataId)
          完了案件のユーザデータ案件プロパティ情報の件数を取得します。
 void updateMatterProperty(UserMatterPropertyModel[] matterProperty)
          完了案件のユーザデータ案件プロパティ情報を更新します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

UserCplMatterPropertyValue

public UserCplMatterPropertyValue(String loginGroupId)
                           throws WorkflowException
コンストラクタ
引数で指定したログイングループIDでユーザデータ案件プロパティ情報(完了案件)マネージャを新しく生成します。

パラメータ:
loginGroupId - ログイングループID
例外:
WorkflowException - ワークフロー例外の親クラス
メソッドの詳細

getMatterProperty

public UserMatterPropertyModel getMatterProperty(String userDataId,
                                                 String key)
                                          throws WorkflowException
完了案件の特定のユーザデータ案件プロパティ情報を取得します。

該当の案件プロパティ情報はパラメータで指定した「userDataId ユーザデータID」と
「key 案件プロパティキー」で「imw_t_cpl_matter_user_data」テーブルから取得します。

検索結果が存在しない場合は、「null」を返却します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドでは、ユーザデータIDをキーで情報を取得しますが、システム案件IDをキーでユーザデータ案件プロパティ情報を取得するには、
CplMatter.getMatterProperty(String)」を利用してください。

特定の案件プロパティキーに限らず、ユーザデータIDの全ての案件プロパティ情報を取得するには「getMatterPropertyList(String)}」を利用してください。

処理中の未完了案件の特定のユーザデータ案件プロパティ情報を取得するには「UserActvMatterPropertyValue.getMatterProperty(String, String)」を利用してください。
過去案件の特定のユーザデータ案件プロパティ情報を取得するには「UserArcMatterPropertyValue.getMatterProperty(String, String)」を利用してください。

パラメータ:
userDataId - ユーザデータID
key - 案件プロパティキー
戻り値:
UserMatterPropertyModel ユーザデータ案件プロパティ情報
例外:
WorkflowException - ワークフロー例外

getMatterPropertyList

public UserMatterPropertyModel[] getMatterPropertyList(String userDataId)
                                                throws WorkflowException
完了案件のユーザデータ案件プロパティ情報をすべて取得します。

該当の案件プロパティ情報はパラメータで指定した「userDataId ユーザデータID」と
「key 案件プロパティキー」で「imw_t_cpl_matter_user_data」テーブルから取得します。

指定のユーザデータIDに対して、検索結果が存在しない場合にはサイズ0の空オブジェクトを返します。
データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドでは、ユーザデータIDをキーで情報を取得しますが、システム案件IDをキーでユーザデータ案件プロパティ情報を取得するには、
CplMatter.getMatterPropertyList()」を利用してください。

特定の案件プロパティキーで、案件プロパティ情報を取得するには「getMatterProperty(String, String)}」を利用してください。

処理中の未完了案件のユーザデータ案件プロパティ情報をすべて取得するには「UserActvMatterPropertyValue.getMatterPropertyList(String)」を利用してください。
過去案件のユーザデータ案件プロパティ情報をすべて取得するには「UserArcMatterPropertyValue.getMatterPropertyList(String)」を利用してください。

パラメータ:
userDataId - ユーザデータID
戻り値:
UserMatterPropertyModel[] ユーザデータ案件プロパティ情報の配列
例外:
WorkflowException - ワークフロー例外

getMatterPropertyListCount

public int getMatterPropertyListCount(String userDataId)
                               throws WorkflowException
完了案件のユーザデータ案件プロパティ情報の件数を取得します。

該当の案件プロパティ件数はパラメータで指定した「userDataId ユーザデータID」と
「key 案件プロパティキー」で「imw_t_cpl_matter_user_data」テーブルから取得します。

データベースへの検索処理が失敗した場合に「WorkflowException」が発生します。

本メソッドでは、ユーザデータIDをキーで情報を取得しますが、システム案件IDをキーでユーザデータ案件プロパティ情報を取得するには、
CplMatter.getMatterPropertyListCount()」を利用してください。

処理中の未完了案件のユーザデータ案件プロパティ情報の件数を取得するには「UserActvMatterPropertyValue.getMatterPropertyListCount(String)」を利用してください。
過去案件のユーザデータ案件プロパティ情報の件数を取得するには「UserArcMatterPropertyValue.getMatterPropertyListCount(String)」を利用してください。

パラメータ:
userDataId - ユーザデータID
戻り値:
int ユーザデータ案件プロパティ情報件数
例外:
WorkflowException - ワークフロー例外

createMatterProperty

public void createMatterProperty(UserMatterPropertyModel[] matterProperty)
                          throws WorkflowException
完了案件のユーザデータ案件プロパティ情報を新規登録します。

指定した「ユーザデータ案件プロパティ情報の配列」を完了案件関連テーブルのユーザデータテーブル「imw_t_cpl_matter_user_data」に登録します。
登録する案件プロパティ情報の配列は必須になります。設定されてない場合は例外「WorkflowException」が発生します。
登録対象になる指定したパラメータの配列の件数と実際に成功した登録件数が異なる場合でも例外「WorkflowException」が発生します。
データベースへの処理で失敗した場合では「WorkflowException」が発生します。

更新、削除処理は「updateMatterProperty(UserMatterPropertyModel[])」、「deleteMatterProperty(UserMatterPropertyModel[])」を利用してください。

このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。

パラメータ:
matterProperty - ユーザデータ案件プロパティ情報の配列
例外:
WorkflowException - ワークフロー例外

updateMatterProperty

public void updateMatterProperty(UserMatterPropertyModel[] matterProperty)
                          throws WorkflowException
完了案件のユーザデータ案件プロパティ情報を更新します。

完了案件関連テーブルのユーザデータテーブル「imw_t_cpl_matter_user_data」に対して更新処理を行います。
更新する案件プロパティ情報の配列は必須になります。設定されてない場合は例外「WorkflowException」が発生します。
指定した「ユーザデータ案件プロパティ情報の配列」モデルで「ユーザデータID」と「案件プロパティキー」をキーにして、
キー以外に設定されている値を更新します。
値を設定していない項目(nullの項目)は更新対象外になります。
データベース更新処理後、実際に更新されたデータが「1」件未満の場合でも例外「WorkflowException」が発生します。
データベースへの処理で失敗した場合では「WorkflowException」が発生します。

登録、削除処理は「createMatterProperty(UserMatterPropertyModel[])」、「deleteMatterProperty(UserMatterPropertyModel[])」を利用してください。

このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。

パラメータ:
matterProperty - ユーザデータ案件プロパティ情報の配列
例外:
WorkflowException - ワークフロー例外

deleteMatterProperty

public void deleteMatterProperty(UserMatterPropertyModel[] matterProperty)
                          throws WorkflowException
完了案件のユーザデータ案件プロパティ情報を削除します。

完了案件関連テーブルのユーザデータテーブル「imw_t_cpl_matter_user_data」に対して削除処理を行います。
削除する案件プロパティ情報の配列は必須になります。設定されてない場合は例外「WorkflowException」が発生します。
指定した「ユーザデータ案件プロパティ情報の配列」モデルに設定された項目の値をキーにしてデータを削除します。
値を設定していない項目(nullの項目)は検索条件から除いて削除処理を行います。
ただし、モデルの全項目を「null」にしても全項目削除にはなりません。例外「WorkflowException」が発生します。
削除をする場合には、必ずひとつ以上の項目に値を設定する必要があります。
データベースへの処理で失敗した場合では「WorkflowException」が発生します。

削除については実際に削除されたデータが「1」件未満の場合でも正常終了になります。

登録、更新処理は「createMatterProperty(UserMatterPropertyModel[])」、「updateMatterProperty(UserMatterPropertyModel[])」を利用してください。

このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。

パラメータ:
matterProperty - ユーザデータ案件プロパティ情報の配列
例外:
WorkflowException - ワークフロー例外の親クラス

IM-Workflow

Copyright © 2000-2015 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.