3.8. 辞書項目検索¶
3.8.1. 辞書項目を検索する¶
3.8.1.1. スクリプト開発モデル¶
・辞書項目を全て呼び出したい場合(※1)sample.js
function openSearchDictionaryDialog() { // 辞書項目検索画面を呼び出します window.open('%ベースURL%/repository/search/metadata/dictionary'); }・有効な辞書項目のデータのみを呼び出したい場合(※2)sample.js
function openSearchDictionaryDialog() { // 辞書項目検索画面を呼び出します window.open('%ベースURL%/repository/search/metadata/dictionary?enabled=true'); }
コラム
下記のようにコールバック関数を利用することもできます。
(※1)の場合(‘%ベースURL%/repository/search/metadata/dictionary#%コールバック関数%’)
(※2)の場合(‘%ベースURL%/repository/search/metadata/dictionary?enabled=true#%コールバック関数%’)
コールバック関数を指定しない場合、デフォルトのコールバック関数は’onDictionarySelected’です。
3.8.2. 結果を返却する¶
3.8.2.1. スクリプト開発モデル¶
sample.js
// 辞書項目検索画面で選択した項目は配列で返却され、上から順番に格納されます。 window.onDictionarySelected = function (selected) { if (selected.length > 0) { // 配列の0番目の辞書項目IDを取得します var itemId = selected[0].properties.itemId; // 配列の0番目の辞書項目名を取得します var itemName = selected[0].localizeName.default; } }コラム
コールバック関数を指定する場合
onDictionarySelectedを指定したコールバック関数に変更してください。
sample.jsの引数の配列オブジェクトの説明をします。
・selected
取得できる情報は、辞書項目とエイリアスの2種類です。
・辞書項目
プロパティ 説明 型 enabledFlag 辞書項目の有効化を示すフラグ boolean label ツリーの表示名 string localizeDescription(※1) 説明 object localizeName(※1) 辞書項目名 object parentId 親のID string properties.enumerationId 参照先列挙ID string properties.enumerationName 参照先列挙名 string properties.itemId 辞書項目ID string properties.usages(※2) 用途 array type item string ・エイリアス
プロパティ 説明 型 label ツリーの表示名 string localizeDescription(※1) 説明 object localizeName(※1) エイリアス名 object parentId 親のID string properties.aliasId エイリアスID string properties.referenceItemId 参照先辞書項目ID string type alias string (※1)localizeDescription、localizeNameには多言語情報が格納されており、構成は以下です。
プロパティ 説明 型 default 標準 string ja 日本語 string en 英語 string zh_CN 中国語(簡体字) string (※2)properties.usagesにはデータ用途と制約用途が格納されており、構成は以下です。
プロパティ 説明 型 name 用途名データ用途の場合はデータ、制約用途の場合は制約です。string usageId 用途IDデータ用途の場合はdata_usage、制約用途の場合はrestriction_usageです。string usageData(※3) 用途 object (※3)現在の用途で用意されている、usageDataには以下の要素が格納されています。
・データ用途
プロパティ 説明 型 databasePhysicalName 辞書項目、または、エイリアスがデータベースで使用された時の物理名。 string databaseScale 辞書項目、または、エイリアスがデータベースで使用された時の最大桁数。 number databaseSize 辞書項目、または、エイリアスがデータベースで使用された時の小数桁数。 number databaseType 辞書項目、または、エイリアスがデータベースで使用された時のデータ型。 string logicalName 辞書項目、または、エイリアスがデータベースで使用された時の論理名。(※1)と同様に多言語情報が格納されています。object comment 辞書項目、または、エイリアスがデータベースで使用された時のコメント。(※1)と同様に多言語情報が格納されています。object javaType 辞書項目、または、エイリアスがJavaで使用された時のデータ型。 string javaVariableName 辞書項目、または、エイリアスがJavaで使用された時の変数名。 string javaScriptType 辞書項目、または、エイリアスがJavaScriptで使用された時の型。 string javaScriptVariableName 辞書項目、または、エイリアスがJavaScriptで使用された時の変数名。 string logicDesignerType 辞書項目、または、エイリアスがIM-LogicDesignerで使用された時の型。 string logicDesignerVariableName 辞書項目、または、エイリアスがIM-LogicDesignerで使用された時の変数名。 string ・制約用途
桁数
プロパティ 説明 型 id 制約IDdigit_restrictionstring max 最大桁数 string min 最小桁数 string バイト数
プロパティ 説明 型 id 制約IDbyte_restrictionstring max 最大バイト数 string min 最小バイト数 string 数値
プロパティ 説明 型 id 制約IDnumeric_restrictionstring max 最大値 string min 最小値 string floatDigitsMax 最大小数桁 string floatDigitsMin 最小小数桁 string integerDigitsMax 最大整数桁 string integerDigitsMin 最小整数桁 string アルファベット
プロパティ 説明 型 id 制約IDalpha_restrictionstring option 大文字・小文字の判定 string symbols 入力可能な記号 string 数字
プロパティ 説明 型 id 制約IDnumber_restrictionstring symbols 入力可能な記号 string アルファベットと数字
プロパティ 説明 型 id 制約IDalphanumeric_restrictionstring option 大文字・小文字の判定 string symbols 入力可能な記号 string ひらがな文字列
プロパティ 説明 型 id 制約IDhiragana_restrictionstring symbols 入力可能な記号 string カタカナ文字列
プロパティ 説明 型 id 制約IDkatakana_restrictionstring option 半角・全角の判定 string symbols 入力可能な記号 string メールアドレス
プロパティ 説明 型 id 制約IDemail_restrictionstring URL
プロパティ 説明 型 id 制約IDurl_restrictionstring 正規表現
プロパティ 説明 型 id 制約IDregex_restrictionstring regex 正規表現 string 日付時刻
プロパティ 説明 型 id 制約IDdatetime_restrictionstring format フォーマット string ID
プロパティ 説明 型 id 制約IDid_restrictionstring UserCd
プロパティ 説明 型 id 制約IDusercd_restrictionstring 列挙型
プロパティ 説明 型 id 制約IDenumeration_restrictionstring enumerationId 列挙ID string
注意
制約によってid以外のプロパティ名が変わるので、注意してください。
コラム
それぞれのプロパティを取得する場合のサンプルは以下の通りです。
※selectedの0番目を取得するものとします。
// 辞書項目名(日本語)を取得する場合
var itemName = selected[0].localizeName.ja;
// 説明(英語)を取得する場合
var description = selected[0].localizeDescription.en;
// 参照先列挙IDを取得する場合
var enumerationId = selected[0].properties.enumerationId;