UserListDisplayPatternオブジェクト
| コンポーネント情報 | |
|---|---|
| since | 7.2 |
利用者一覧表示パターンマネージャオブジェクト。
コンストラクタに指定したユーザの各画面一覧の表示パターンを管理できます。
データベーステーブル「imw_t_user_select_column_list」に対して、
登録した一覧データの取得や、新規登録、更新、削除することができます。
コンストラクタに指定したユーザの各画面一覧の表示パターンを管理できます。
データベーステーブル「imw_t_user_select_column_list」に対して、
登録した一覧データの取得や、新規登録、更新、削除することができます。
コンストラクタの概要
UserListDisplayPattern (String userCd) コンストラクタ。 |
UserListDisplayPattern (String loginGroupId, String userCd) 非推奨コンストラクタ。
UserListDisplayPattern(String userCd) を使用してください。
|
メソッドの概要
| 返却値の型 | メソッド名 |
|---|---|
| WorkflowResultInfo | createUserListPattern (Array userListPattern) 利用者一覧表示パターンを新規登録・更新します。 |
| WorkflowResultInfo | deleteUserListPattern (Array userListPattern) 利用者一覧表示パターンを削除します。 |
| WorkflowResultInfo | getAvailableListPattern (String listPageType) 指定した一覧画面種別において有効な一覧表示パターンを取得します。 |
コンストラクタの詳細
UserListDisplayPattern (String userCd)
コンストラクタ。
引数で指定したユーザコードで利用者一覧表示パターンマネージャを 新しく生成します。
パラメータ
|
UserListDisplayPattern (String loginGroupId, String userCd)
非推奨
UserListDisplayPattern(String userCd) を使用してください。
コンストラクタ。
引数で指定したログイングループID、ユーザコードで利用者一覧表示パターンマネージャを 新しく生成します。
パラメータ
|
メソッドの詳細
WorkflowResultInfo createUserListPattern (Array userListPattern)
利用者一覧表示パターンを新規登録・更新します。
コンストラクタに指定したユーザの一覧表示パターン情報の登録処理を行います。 パラメータで指定した「利用者一覧表示パターン情報オブジェクト」の「一覧画面種別」の情報が既に登録対象ユーザに存在する場合は 既存データの「パターンID」の更新処理を行います。 「userListPattern 利用者一覧表示パターン情報オブジェクトの配列」の設定は必須です。 指定していない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。 指定した「利用者一覧表示パターン情報オブジェクト」の「一覧画面種別」はコード一覧の値を指定する必要があります。 一覧に存在しない値を指定した場合にも処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。 登録処理を行う際に、各画面種別に対して、データベースへの登録結果の件数が１件ではない場合はエラー情報を格納した結果オブジェクトを返却します。 更新処理を行う際に、各画面種別に対して、データベースへの更新結果の件数が１件未満の場合にもエラー情報を格納した結果オブジェクトを返却します。 登録したユーザ一覧表示パターンの削除は、「deleteUserListPattern(Array)」を利用してください。 このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。
パラメータ
返却値
|
WorkflowResultInfo deleteUserListPattern (Array userListPattern)
利用者一覧表示パターンを削除します。
コンストラクタに指定したユーザの一覧表示パターン情報の削除処理を行います。 「userListPattern 利用者一覧表示パターン情報の配列」の設定は必須です。 指定していない場合は処理に失敗し、エラー情報を格納した結果オブジェクトを返却します。 削除処理は指定した「利用者一覧表示パターン情報オブジェクト」の「一覧画面種別」での削除処理になります。 「パターンID」の指定は無視されます。 設定された「一覧画面種別」に対して、チェック処理は行なっていません。 削除処理を行う際に、指定した値での削除処理結果件数が０件の場合でもエラーにはなりません。正常終了します。 ユーザ一覧表示パターンの新規登録・更新は、「createUserListPattern(Array)」を利用してください。 このメソッドでは内部でトランザクション制御を行なっていません。外部で制御を行う必要があります。
パラメータ
返却値
|
WorkflowResultInfo getAvailableListPattern (String listPageType)
指定した一覧画面種別において有効な一覧表示パターンを取得します。
ユーザが設定をしていない場合は、システム標準の一覧表示パターンを返却します。 ユーザが設定したデータが存在しない場合は、システム標準の一覧表示パターンを返却します。 システム標準の一覧も存在しない場合はdata属性に「null」を設定して返却します。 データベースへの検索処理で失敗した場合にはエラー情報を格納した結果オブジェクトを返却します。 結果を保存する「利用者一覧表示パターン情報オブジェクト」に設定される情報はユーザの設定の場合は 「imw_t_user_select_column_list」から取得します。 ユーザ設定が存在しない場合はマスタテーブルである「imw_m_list_pattern」から 「DEFAULT_FLAG」が「１」のシステム設定を取得します。 ユーザの一覧表示パターンの登録は「createUserListPattern(Array)」を利用してください。
パラメータ
返却値
|