5.1. 検索画面タブPlugin共通の仕様¶
本節では、検索画面タブ共通の仕様についてまとめています。
項目
5.1.1. 画面起動引数¶
検索画面を起動する際に、起動引数を指定する必要があります。
検索画面起動引数には、以下の種類があります。
- 画面構築基盤用
- 共通パラメータ
- 準共通パラメータ
- ユーザ検索固有
- 暗黙条件
画面起動引数の詳細は『IM-共通マスタ スマートフォン版検索画面起動引数一覧 』を参考にしてください。以降、各検索画面タブで共通の仕様となる画面起動引数(画面構築基盤用、共通パラメータ、準共通パラメータ)を列挙します。ユーザ検索固有、暗黙条件については、検索画面タブ毎に指定可能なものが異なりますので、各検索タブを参照してください。
5.1.1.1. 画面構築基盤用¶
共通検索画面の外枠をなす画面構築基盤への引数です。主に画面表示時のタイトルラベルや、検索後、選択決定時のウィンドウの挙動などに関する設定をします。
検索対象(使用拡張ポイント)検索機能を選択します。設定する拡張ポイントによって機能が変わります。標準で提供している拡張ポイントは、「指定方法(1) デフォルトで提供する拡張ポイントの利用 」を参照してください。
プロパティ名 型 必須 初期値 備考 target String × -
基本情報描画領域基本情報描画領域の表示/非表示を切り替えます。
プロパティ名 型 必須 初期値 備考 basic_area String × - true :表示するfalse:表示しない
使用タブセット上記の検索対象を設定せず、実行時に使用する検索画面タブを設定したい場合にこの項目を使用します。指定可能な検索画面タブは「検索画面タブPlugin指定 」を参照してください。
プロパティ名 型 必須 初期値 備考 tabs Array × - 配列インデックス Object × - id String ○ - 検索画面タブPlugin ID title String ○ -
ウィンドウタイトルポップアップしたウィンドウのタイトルに表示する文字列です。
プロパティ名 型 必須 初期値 備考 wnd_title String × intra-mart
タイトルバーメッセージタイトルバーに表示するメッセージ(キャプション)です。
プロパティ名 型 必須 初期値 備考 message String × -
コールバックファンクション検索した結果を返す関数を指定します。結果は指定した関数の引数に渡されます。
プロパティ名 型 必須 初期値 備考 callback_function String ○ - imACMSearchSp
タブの初期フォーカス画面を初期表示したときに表示するタブを選択します。検索画面タブPlugin IDを指定します。デフォルトでは検索方法・対象で選択できる最初のタブにフォーカスされます。
プロパティ名 型 必須 初期値 備考 default_tab_id String × -
単一選択・複数選択検索結果を単一選択とするか、複数選択とするかを設定します。
プロパティ名 型 必須 初期値 備考 type String × multiple multiple : 複数選択single : 単一
初期選択オブジェクト画面起動時に選択一覧に入れておくオブジェクトの配列を設定します。何も設定しなければ選択一覧には何も表示されません。このオブジェクトの形式は戻り値の形式のJSONオブジェクトでなければ正常に表示されません。戻り値の形式については、「戻り値の形式 」を参照してください。
プロパティ名 型 必須 初期値 備考 default_selected Array × - 配列インデックス Object × - 結果形式のJSONオブジェクト
5.1.1.2. 共通パラメータ¶
多くの機能で共通して利用するパラメータです。検索の基本条件となる引数です。検索基準日、検索対象ロケール、削除されたデータの取得有無に関する設定をします。
検索基準日期間化された情報を取得する際基準にする日付を指定します。
プロパティ名 型 必須 初期値 備考 target_date Date × システム日付
削除データの使用論理削除状態のデータを検索対象にするかどうかを設定します。
プロパティ名 型 必須 初期値 備考 deleted_data Boolean × false true : 論理削除データを取得false: 論理削除データを取得しない
表示ロケール表示ロケールを設定します。検索結果もこのロケール表示で返します。
プロパティ名 型 必須 初期値 備考 target_locale String × 現在のログインユーザのロケール
5.1.1.3. 準共通パラメータ¶
多くの機能で共通して利用するパラメータです。タブ毎にそれぞれ設定する必要があります。
取得する情報(項目)検索画面タブ毎に、取得するテーブルのカラム名を設定します。検索タブにより、取得できるテーブルが異なります。
プロパティ名 型 必須 初期値 備考 prop Array × 検索タブPlugin ID Object × 配列インデックス String ○ 取得したいカラム名
5.1.2. キーワード検索について¶
キーワードを使用して検索し、一覧を表示するコントロールが各所に存在しますが、一覧表示においては大量データモード設定時に以下のような制限を受けます。詳細は各検索画面タブを参照してください。コラム
設定ファイルに設定されている制限件数をデータベースから取得する最大の件数とし、それ以上のデータがあっても取得しません。(ユーザ情報、ロール情報)
5.1.3. 階層表示の展開処理¶
階層の表示は1階層毎の表示となりますが、取得する情報は、PC版の共通検索画面のツリー表示と同等です。詳細は、「IM-共通マスタ 検索画面仕様書」を参照してください。
5.1.4. 内包型エンティティの比較条件の取扱¶
内包構造を持つエンティティにおいて、比較演算子を指定する場合の振る舞いは、PC版の共通検索画面と同等です。詳細は、「IM-共通マスタ 検索画面仕様書」を参照してください。
5.1.5. 内包型エンティティにつく分類を指定した場合の条件の取扱¶
内包型エンティティにつく分類を指定した場合の振る舞いは、PC版の共通検索画面と同等です。詳細は、「IM-共通マスタ 検索画面仕様書」を参照してください。
5.1.6. 組織セットの表示について¶
組織セットの表示については、PC版の共通検索画面と同等です。詳細は、「IM-共通マスタ 検索画面仕様書」を参照してください。
5.1.7. 組織リストの適用について¶
組織リストの適用についてPC版の共通検索画面と同等です。詳細は、「IM-共通マスタ 検索画面仕様書」を参照してください。
5.1.8. 戻り値の形式¶
検索画面タブの戻り値は以下の形式となります。
プロパティ名 型 説明 type String このオブジェクトの型を表す。主にアプリケーション側で型の判別ができるように提示するもの。アプリケーション共通マスタが標準で提供する機能の範囲では、取得した情報元のテーブル名を設定する。 keyFields Array 文字列の配列。data 内で一意性を表すキーとなるプロパティのプロパティ名を配列として保持する。検索画面の選択内容一覧において重複選択を避ける為のガイドとして使用する。具体的にはdataからkeyFieldsに設定された名前のプロパティを取得し、同一typeを含めて比較して重複をチェックする。 displayName String オブジェクトを画面に表示する際に使用する表示文字列 data Objcet 実際にデータベースから取得したレコードの内容がオブジェクトとして設定される。引数の「取得する情報(prop)」に指定された項目をデータベースから取得し、その名称のプロパティを設定する。【表:情報オブジェクトの形式(Object)】