4.2. 列挙型検索¶
4.2.1. 列挙型を検索する¶
4.2.1.1. スクリプト開発モデル¶
・列挙を全て呼び出したい場合(※1)sample.js
function openSearchEnumerationDialog() { // 列挙型検索画面を呼び出します window.open('%ベースURL%/repository/search/metadata/enumeration'); }・列挙が有効化のデータのみを呼び出したい場合(※2)sample.js
function openSearchEnumerationDialog() { // 列挙型検索画面を呼び出します window.open('%ベースURL%/repository/search/metadata/enumeration?enabled=true'); }コラム
下記のようにコールバック関数を利用することもできます。
(※1)の場合(‘%ベースURL%/repository/search/metadata/enumeration#%コールバック関数%’)
(※2)の場合(‘%ベースURL%/repository/search/metadata/enumeration?enabled=true#%コールバック関数%’)
コールバック関数を指定しない場合、デフォルトのコールバック関数は’onEnumerationSelected’です。
4.2.2. 結果を返却する¶
4.2.2.1. スクリプト開発モデル¶
sample.js
window.onEnumerationSelected = function (selected) { if (selected) { // 列挙IDを取得します var enumerationId = selected.identify; // 列挙名を取得します var enumerationName = selected.name.default; } }コラム
コールバック関数を指定する場合
onEnumerationSelectedを指定したコールバック関数に変更してください。
sample.jsの引数のオブジェクトの説明をします。
・selected
取得できる情報は、以下です。
プロパティ | 説明 | 型 |
---|---|---|
identify | 型を含まない列挙ID | string |
parentId | 親のID | string |
name(※1) | 列挙名 | object |
description(※1) | 説明 | object |
enumerationItems(※2) | 列挙項目 | array |
enabled | 列挙の有効化を示すフラグ | boolean |
label | ツリーの表示名 | string |
(※1)name、descriptionには多言語情報が格納されており、構成は以下です。
プロパティ | 説明 | 型 |
---|---|---|
default | 標準 | string |
ja | 日本語 | string |
en | 英語 | string |
zh_CN | 中国語(簡体字) | string |
(※2)enumerationItemsには以下の要素が格納されています。
プロパティ | 説明 | 型 |
---|---|---|
label(※3) | 列挙項目表示名 | object |
value | 値 | string |
(※3)labelも多言語情報が格納されています。構成はname、descriptionと同様です。
コラム
それぞれのプロパティを取得する場合のサンプルは以下の通りです。
// 列挙名(日本語)を取得する場合 var enumerationName = selected.name.ja; // 説明(英語)を取得する場合 var description = selected.description.en; // 列挙項目の1件目の列挙項目表示名(標準)を取得する場合 var enumerationName = selected.enumerationItems[0].label.default;