ListDisplayPatternManagerオブジェクト
| コンポーネント情報 | |
|---|---|
| version | 8.0.22 |
| since | 7.2 |
一覧表示パターン定義情報を管理するマネージャです。
一覧表示パターン定義情報の登録、更新、削除、取得を行います。
一覧表示パターン定義情報の登録、更新、削除、取得を行います。
コンストラクタの概要
| ListDisplayPatternManager () コンストラクタ |
ListDisplayPatternManager (String loginGroupId) 非推奨コンストラクタ
ListDisplayPatternManager() を使用してください。
|
メソッドの概要
| 返却値の型 | メソッド名 |
|---|---|
| WorkflowResultInfo | createListPatternDataFamily (Array models) 一覧表示パターン定義情報と配下の情報を新規作成します。 |
| WorkflowResultInfo | createListPatternData (Array models) 一覧パターン情報を新規作成します。 |
| WorkflowResultInfo | createMappingData (Array models) 一覧パターンマッピング情報を新規作成します。 |
| WorkflowResultInfo | createSelectedColumnListData (Array models) 一覧選択カラム情報を新規作成します。 |
| WorkflowResultInfo | deleteListPatternDataFamily (Array models) 一覧表示パターン定義情報と配下の情報を削除します。 |
| WorkflowResultInfo | deleteListPatternData (Array models) 一覧パターン情報を削除します。 |
| WorkflowResultInfo | deleteMappingData (Array models) 一覧パターンマッピング情報を削除します。 |
| WorkflowResultInfo | deleteSelectedColumnListData (Array models) 一覧選択カラム情報を削除します。 |
| WorkflowResultInfo | getColumnDataListWithListPageType (String listPageType) 指定した一覧画面種別で一覧表示カラム情報を取得します。 |
| WorkflowResultInfo | getEffectivePatternIdWithFlowGroup (String flowGroupId, String listPageType) 指定されたフローグループID、一覧画面種別からフローグループに適用されるパターンIDを取得します。 |
| WorkflowResultInfo | getEffectivePatternIdWithFlow (String flowId, String listPageType, String flowGroupId) 指定されたフローID、一覧画面種別、フローグループIDからフローに適用されるパターンIDを取得します。 |
| WorkflowResultInfo | getListPatternDataCountWithLocale (String patternId, String localeId) 指定したロケールIDで一覧表示パターン定義情報の件数を取得します。 |
| WorkflowResultInfo | getListPatternDataCount (String patternId) 一覧表示パターン定義情報の全ロケール分の件数を取得します。 |
| WorkflowResultInfo | getListPatternDataFamilyWithLocale (String patternId, String localeId) 指定したロケールIDで一覧表示パターン定義情報と配下の情報を１件取得します。 |
| WorkflowResultInfo | getListPatternDataFamily (String patternId) 一覧表示パターン定義情報と配下の情報を全ロケール分取得します。 |
| WorkflowResultInfo | getListPatternDataListCount (ListPatternSearchConditionInfo condition) 指定した検索条件で一覧表示パターン定義情報の検索結果件数を取得します。 |
| WorkflowResultInfo | getListPatternDataList (ListPatternSearchConditionInfo condition) 指定した検索条件で一覧表示パターン定義情報を検索します。 |
| WorkflowResultInfo | getListPatternDataWithLocale (String patternId, String localeId) 指定したロケールIDで一覧パターン情報を１件取得します。 |
| WorkflowResultInfo | getListPatternData (String patternId) 一覧パターン情報を全ロケール分取得します。 |
| WorkflowResultInfo | getMappingDataWithTarget (パターンマッピング対象コード patternMappingTargetCode, patternMappingTargetType, listPageType指定されたマッピング対象から一覧パターンマッピング情報を取得します。 |
| WorkflowResultInfo | getMappingData (String patternId) 指定されたパターンIDから一覧パターンマッピング情報を取得します。 |
| WorkflowResultInfo | getMappingTargetData (String patternId, String localeId) 指定されたパターンID、ロケールIDから一覧パターンマッピング対象情報を取得します。 |
| WorkflowResultInfo | getMappingTargetFlowData (フローID flowId, listPageType, localeId, フローグループ階層数 flowGroupHierarchy) 指定されたフローID、一覧画面種別、ロケールID、フローグループ階層数からマッピング対象フロー選択用の一覧を取得します。 |
| WorkflowResultInfo | getMappingTargetFlowGroupData (listPageType, localeId, フローグループ階層数 flowGroupHierarchy) 指定された一覧画面種別、ロケールID、フローグループ階層数からマッピング対象フローグループ選択用の一覧を取得します。 |
| WorkflowResultInfo | getSelectedColumnListData (String patternId) 一覧選択カラム情報を取得します。 |
| WorkflowResultInfo | getUserSelectColumnListDataCountWithListPageTypeAndPatternId (String listPageType, String patternId) 指定した一覧画面種別とパターンIDでユーザ選択一覧パターン情報の件数を取得します。 |
| WorkflowResultInfo | updateListPatternDataFamily (Array models) 一覧表示パターン定義情報と配下の情報を更新します。 |
| WorkflowResultInfo | updateListPatternData (Array models) 一覧パターン情報を更新します。 |
| WorkflowResultInfo | updateMappingData (Array models) 一覧パターンマッピング情報を更新します。 |
| WorkflowResultInfo | updateSelectedColumnListData (Array models) 一覧選択カラム情報を更新します。 |
コンストラクタの詳細
| ListDisplayPatternManager ()
コンストラクタ
一覧表示パターン定義情報管理マネージャを新しく生成します。 |
ListDisplayPatternManager (String loginGroupId)
非推奨
ListDisplayPatternManager() を使用してください。
コンストラクタ
引数で指定したログイングループIDで一覧表示パターン定義情報管理マネージャを新しく生成します。
パラメータ
|
メソッドの詳細
WorkflowResultInfo createListPatternDataFamily (Array models)
一覧表示パターン定義情報と配下の情報を新規作成します。
models 内の一覧パターン情報、一覧選択カラム情報、一覧パターンマッピング情報の指定に基づいて新規作成しますが、 データ矛盾のチェックを行いません。 models 内のデフォルトフラグに「設定する」が設定されている場合に一覧パターン情報の 同一一覧画面種別の他データ（models 内の一覧画面種別と一致するデータ）のデフォルトフラグを 「設定しない」に更新します。 models 内のデフォルトフラグに「設定しない」が設定されている場合は同一一覧画面種別他データの 更新を行いません。 models 内に一覧選択カラム情報、一覧パターンマッピング情報を指定した場合は、一覧選択カラム情報、一覧パターンマッピング情報を新規作成します。
パラメータ
返却値
|
WorkflowResultInfo createListPatternData (Array models)
一覧パターン情報を新規作成します。
models 内のデフォルトフラグに「設定する」が設定されている場合に一覧パターン情報の 同一一覧画面種別の他データ（models 内の一覧画面種別と一致するデータ）のデフォルトフラグを 「設定しない」に更新します。 models 内のデフォルトフラグに「設定しない」が設定されている場合は同一一覧画面種別他データの 更新を行いません。 models 内に一覧選択カラム情報、一覧パターンマッピング情報を指定した場合でも、一覧選択カラム情報、一覧パターンマッピング情報は新規作成しません。 全ての情報を新規作成する場合は createListPatternDataFamily を使用してください。 ワークフロー上で使用可能にするためには一覧選択カラム情報の作成が必要です。
パラメータ
返却値
|
WorkflowResultInfo createMappingData (Array models)
一覧パターンマッピング情報を新規作成します。
パラメータ
返却値
|
WorkflowResultInfo createSelectedColumnListData (Array models)
一覧選択カラム情報を新規作成します。
パラメータ
返却値
|
WorkflowResultInfo deleteListPatternDataFamily (Array models)
一覧表示パターン定義情報と配下の情報を削除します。
models 内の一覧パターン情報、一覧選択カラム情報、一覧パターンマッピング情報の指定に基づいて削除しますが、 データ矛盾のチェックを行いません。 models 内のフローグループIDは必須、一覧選択カラム情報、一覧パターンマッピング情報は任意、それ以外の項目は無視します。 models 内に一覧選択カラム情報、一覧パターンマッピング情報を指定した場合は、指定の一覧選択カラム情報、一覧パターンマッピング情報を削除します。 models 内に一覧選択カラム情報、一覧パターンマッピング情報を指定しない場合は、キー情報に一致する一覧選択カラム情報、一覧パターンマッピング情報を削除します。
パラメータ
返却値
|
WorkflowResultInfo deleteListPatternData (Array models)
一覧パターン情報を削除します。
models 内に一覧選択カラム情報、一覧パターンマッピング情報を指定した場合でも、一覧選択カラム情報、一覧パターンマッピング情報は削除しません。 全ての情報を削除する場合は deleteListPatternDataFamily を使用してください。
パラメータ
返却値
|
WorkflowResultInfo deleteMappingData (Array models)
一覧パターンマッピング情報を削除します。
パラメータ
返却値
|
WorkflowResultInfo deleteSelectedColumnListData (Array models)
一覧選択カラム情報を削除します。
パラメータ
返却値
|
WorkflowResultInfo getColumnDataListWithListPageType (String listPageType)
指定した一覧画面種別で一覧表示カラム情報を取得します。
パラメータ
返却値
|
WorkflowResultInfo getEffectivePatternIdWithFlowGroup (String flowGroupId, String listPageType)
指定されたフローグループID、一覧画面種別からフローグループに適用されるパターンIDを取得します。
フローグループID、一覧画面種別は必須項目です。 指定されたフローグループIDに紐づくパターンIDが存在しない場合、下記の通りパターンIDを取得します。 指定されたフローグループIDの親フローグループID、一覧画面種別から適用されるパターンIDを再帰的に取得します。 指定されたフローグループIDに親フローグループIDが存在しない、または親フローグループIDに紐づくパターンIDが存在しない場合、指定された一覧画面種別に標準設定されたパターンIDを取得します。
パラメータ
返却値
|
WorkflowResultInfo getEffectivePatternIdWithFlow (String flowId, String listPageType, String flowGroupId)
指定されたフローID、一覧画面種別、フローグループIDからフローに適用されるパターンIDを取得します。
フローID、一覧画面種別は必須項目、フローグループIDは任意項目です。 フローグループIDには指定されたフローIDの属するフローグループIDを設定します。 指定されたフローIDに紐づくパターンIDが存在しない場合、下記の通りパターンIDを取得します。 フローグループIDが指定された場合は、指定されたフローグループID、一覧画面種別から適用されるパターンIDを取得します。 指定したフローIDと紐づきのないフローグループIDが指定された場合は、標準パターンIDを取得します。 フローグループIDの指定がない場合は、指定された一覧画面種別に標準設定されたパターンIDを取得します。
返却値
|
WorkflowResultInfo getListPatternDataCountWithLocale (String patternId, String localeId)
指定したロケールIDで一覧表示パターン定義情報の件数を取得します。
パラメータ
返却値
|
WorkflowResultInfo getListPatternDataCount (String patternId)
一覧表示パターン定義情報の全ロケール分の件数を取得します。
ロケールの指定を行う場合は getListPatternDataCountWithLocale を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getListPatternDataFamilyWithLocale (String patternId, String localeId)
指定したロケールIDで一覧表示パターン定義情報と配下の情報を１件取得します。
一覧選択カラム情報、一覧パターンマッピング情報の取得も行います。 国際化対応されている情報の場合は、指定したロケールIDのみを取得します。 該当する一覧表示パターン定義情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
返却値
|
WorkflowResultInfo getListPatternDataFamily (String patternId)
一覧表示パターン定義情報と配下の情報を全ロケール分取得します。
一覧パターン情報の他に一覧選択カラム情報、一覧パターンマッピング情報の取得も行います。 登録されている全ロケール分を取得します。 ロケールの指定を行う場合は getListPatternDataFamilyWithLocale を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getListPatternDataListCount (ListPatternSearchConditionInfo condition)
指定した検索条件で一覧表示パターン定義情報の検索結果件数を取得します。
condition で指定したロケールIDを検索条件に使用します。 null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
返却値
|
WorkflowResultInfo getListPatternDataList (ListPatternSearchConditionInfo condition)
指定した検索条件で一覧表示パターン定義情報を検索します。
condition で指定したロケールIDを検索条件に使用します。 null を指定した場合は、登録されている全ロケール分を取得します。
パラメータ
返却値
|
WorkflowResultInfo getListPatternDataWithLocale (String patternId, String localeId)
指定したロケールIDで一覧パターン情報を１件取得します。
一覧選択カラム情報、一覧パターンマッピング情報は取得しません。 全ての情報を取得する場合は getListPatternDataFamilyWithLocale を使用してください。 該当する一覧パターン情報が見つからなかった場合は、処理結果のdata属性にnullが設定されます。
パラメータ
返却値
|
WorkflowResultInfo getListPatternData (String patternId)
一覧パターン情報を全ロケール分取得します。
一覧選択カラム情報、一覧パターンマッピング情報は取得しません。 全ての情報を取得する場合は getListPatternDataFamily を使用してください。 登録されている全ロケール分を取得します。 ロケールの指定を行う場合は getListPatternDataWithLocale を使用してください。
パラメータ
返却値
|
WorkflowResultInfo getMappingDataWithTarget (パターンマッピング対象コード patternMappingTargetCode, patternMappingTargetType, listPageType
指定されたマッピング対象から一覧パターンマッピング情報を取得します。
パラメータ
返却値
|
WorkflowResultInfo getMappingData (String patternId)
指定されたパターンIDから一覧パターンマッピング情報を取得します。
パラメータ
返却値
|
WorkflowResultInfo getMappingTargetData (String patternId, String localeId)
指定されたパターンID、ロケールIDから一覧パターンマッピング対象情報を取得します。
パラメータ
返却値
|
WorkflowResultInfo getMappingTargetFlowData (フローID flowId, listPageType, localeId, フローグループ階層数 flowGroupHierarchy)
指定されたフローID、一覧画面種別、ロケールID、フローグループ階層数からマッピング対象フロー選択用の一覧を取得します。
フローID、一覧画面種別、ロケールIDは必須項目、フローグループ階層数は任意項目です。 フローグループ階層数に指定された階層数までを取得対象とします。 フローグループ階層数が未指定の場合は、全ての階層を取得対象とします。
パラメータ
返却値
|
WorkflowResultInfo getMappingTargetFlowGroupData (listPageType, localeId, フローグループ階層数 flowGroupHierarchy)
指定された一覧画面種別、ロケールID、フローグループ階層数からマッピング対象フローグループ選択用の一覧を取得します。
フローID、一覧画面種別、ロケールIDは必須項目、フローグループ階層数は任意項目です。 フローグループ階層数に指定された階層数までを取得対象とします。 フローグループ階層数が未指定の場合は、全ての階層を取得対象とします。
パラメータ
返却値
|
WorkflowResultInfo getSelectedColumnListData (String patternId)
一覧選択カラム情報を取得します。
パラメータ
返却値
|
WorkflowResultInfo getUserSelectColumnListDataCountWithListPageTypeAndPatternId (String listPageType, String patternId)
指定した一覧画面種別とパターンIDでユーザ選択一覧パターン情報の件数を取得します。
パラメータ
返却値
|
WorkflowResultInfo updateListPatternDataFamily (Array models)
一覧表示パターン定義情報と配下の情報を更新します。
models 内の一覧パターン情報、一覧選択カラム情報、一覧パターンマッピング情報の指定に基づいて更新しますが、 データ矛盾のチェックを行いません。 models 内のパターンID、ロケールIDは必須で、それ以外の項目は任意です。 models 内のデフォルトフラグに「設定する」が設定されている場合に一覧パターン情報の 同一一覧画面種別の他データ（models 内の一覧画面種別と一致するデータ）のデフォルトフラグを 「設定しない」に更新します。 models 内のデフォルトフラグに「設定しない」が設定されている場合は同一一覧画面種別他データの 更新を行いません。 models 内に一覧選択カラム情報を指定した場合は、一覧選択カラム情報の更新を行います。 一覧選択カラム情報は登録済みの情報を削除し、新たに情報を登録します。 models 内に一覧パターンマッピング情報を指定した場合は、一覧パターンマッピング情報の更新を行います。 一覧パターンマッピング情報は登録済みの情報を削除し、新たに情報を登録します。
パラメータ
返却値
|
WorkflowResultInfo updateListPatternData (Array models)
一覧パターン情報を更新します。
models 内のデフォルトフラグに「設定する」が設定されている場合に一覧パターン情報の 同一一覧画面種別の他データ（models 内の一覧画面種別と一致するデータ）のデフォルトフラグを 「設定しない」に更新します。 models 内のデフォルトフラグに「設定しない」が設定されている場合は同一一覧画面種別他データの 更新を行いません。 models 内に一覧選択カラム情報、一覧パターンマッピング情報を指定した場合でも、一覧選択カラム情報、一覧パターンマッピング情報は更新しません。 全ての情報を更新する場合は updateListPatternDataFamily を使用してください。
パラメータ
返却値
|
WorkflowResultInfo updateMappingData (Array models)
一覧パターンマッピング情報を更新します。
一覧パターンマッピング情報は登録済みの情報を削除し、新たに情報を登録します。
パラメータ
返却値
|
WorkflowResultInfo updateSelectedColumnListData (Array models)
一覧選択カラム情報を更新します。
一覧選択カラム情報は登録済みの情報を削除し、新たに情報を登録します。
パラメータ
返却値
|