UserActvMatterPropertyValueオブジェクト

コンポーネント情報
since	7.2

コンポーネント概要

ユーザデータ案件プロパティ情報マネージャオブジェクト。

ユーザデータ案件プロパティ情報の新規登録、更新、削除を行います。

本オブジェクトではユーザデータIDをキーで検索や更新処理を行います。検索や更新処理の対象になるテーブルは未完了案件関連テーブルである「imw_t_user_data」です。

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

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

関連オブジェクト:UserCplMatterPropertyValue, UserArcMatterPropertyValue, ActvMatter

コンストラクタの概要

UserActvMatterPropertyValue () コンストラクタ。
UserActvMatterPropertyValue (String `loginGroupId`) 非推奨コンストラクタ。 UserActvMatterPropertyValue() を使用してください。

メソッドの概要

返却値の型	メソッド名
WorkflowResultInfo	createMatterProperty (Array `matterProperty`) ユーザデータ案件プロパティ情報を新規登録します。
WorkflowResultInfo	deleteMatterProperty (Array `matterProperty`) ユーザデータ案件プロパティ情報を削除します。
WorkflowResultInfo	getMatterPropertyListCount (String `userDataId`) ユーザデータ案件プロパティ情報の件数を取得します。
WorkflowResultInfo	getMatterPropertyList (String `userDataId`) ユーザデータ案件プロパティ情報をすべて取得します。
WorkflowResultInfo	getMatterProperty (String `userDataId`, String `key`) ユーザデータ案件プロパティ情報を取得します。
WorkflowResultInfo	updateMatterProperty (Array `matterProperty`) ユーザデータ案件プロパティ情報を更新します。

コンストラクタの詳細

UserActvMatterPropertyValue ()

コンストラクタ。
ユーザデータ案件プロパティ情報マネージャを新しく生成します。

UserActvMatterPropertyValue (String loginGroupId) 非推奨

UserActvMatterPropertyValue() を使用してください。

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

パラメータ

loginGroupId : String: ログイングループID

メソッドの詳細

WorkflowResultInfo createMatterProperty (Array matterProperty)

ユーザデータ案件プロパティ情報を新規登録します。

指定した「ユーザデータ案件プロパティ情報オブジェクトの配列」を未完了案件関連テーブルのユーザデータテーブル「imw_t_user_data」に登録します。
登録する案件プロパティ情報オブジェクトの配列は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
登録対象になる指定したパラメータの配列の件数と実際に成功した登録件数が異なる場合でもエラー情報を格納した結果オブジェクトを返却します。
データベースへの処理で失敗した場合でもエラー情報を格納した結果オブジェクトを返却します。

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

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

パラメータ

matterProperty : Array: ユーザデータ案件プロパティ情報オブジェクトの配列

返却値

WorkflowResultInfo: WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

WorkflowResultInfo deleteMatterProperty (Array matterProperty)

ユーザデータ案件プロパティ情報を削除します。

未完了案件関連テーブルのユーザデータテーブル「imw_t_user_data」に対して削除処理を行います。
削除する案件プロパティ情報オブジェクトの配列は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
指定した「ユーザデータ案件プロパティ情報オブジェクトの配列」モデルに設定された項目の値をキーにしてデータを削除します。
値を設定していない項目（nullの項目）は検索条件から除いて削除処理を行います。
ただし、モデルの全項目を「null」にしても全項目削除にはなりません。処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
削除をする場合には、必ずひとつ以上の項目に値を設定する必要があります。
データベースへの処理で失敗した場合ではエラー情報を格納した結果オブジェクトを返却します。

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

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

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

パラメータ

matterProperty : Array: ユーザデータ案件プロパティ情報オブジェクトの配列

返却値

WorkflowResultInfo: WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。

WorkflowResultInfo getMatterPropertyListCount (String userDataId)

ユーザデータ案件プロパティ情報の件数を取得します。

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

データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

パラメータ

userDataId : String: ユーザデータID

返却値

WorkflowResultInfo: WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ユーザデータ案件プロパティ情報件数(Number)が設定されます。

WorkflowResultInfo getMatterPropertyList (String userDataId)

ユーザデータ案件プロパティ情報をすべて取得します。

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

指定のユーザデータIDに対して、検索結果が存在しない場合にはdata属性にサイズ０の空オブジェクトを設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

パラメータ

userDataId : String: ユーザデータID

返却値

WorkflowResultInfo: WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ユーザデータ案件プロパティ情報オブジェクトの配列が設定されます。

WorkflowResultInfo getMatterProperty (String userDataId, String key)

ユーザデータ案件プロパティ情報を取得します。

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

検索結果が存在しない場合には、data属性に「null」を設定して返却します。
データベースへの検索処理が失敗した場合には、エラー情報を格納した結果オブジェクトを返却します。

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

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

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

パラメータ

userDataId : String: ユーザデータID

key : String: 案件プロパティキー

返却値

WorkflowResultInfo: WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、ユーザデータ案件プロパティ情報オブジェクトが設定されます。

WorkflowResultInfo updateMatterProperty (Array matterProperty)

ユーザデータ案件プロパティ情報を更新します。

未完了案件関連テーブルのユーザデータテーブル「imw_t_user_data」に対して更新処理を行います。
更新する案件プロパティ情報オブジェクトの配列は必須になります。設定されてない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。
指定した「ユーザデータ案件プロパティ情報オブジェクトの配列」モデルで「ユーザデータID」と「案件プロパティキー」をキーにして、
キー以外に設定されている値を更新します。
値を設定していない項目（nullの項目）は更新対象外になります。
データベース更新処理後、実際に更新されたデータが「１」件未満の場合でもエラー情報を格納した結果オブジェクトを返却します。
データベースへの処理で失敗した場合でもエラー情報を格納した結果オブジェクトを返却します。

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

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

パラメータ

matterProperty : Array: ユーザデータ案件プロパティ情報オブジェクトの配列

返却値

WorkflowResultInfo: WorkflowResultInfo 処理結果を返却します。
WorkflowResultInfo のdata属性には、nullが設定されます。