v_query – スコープ、グローバル

v_query API は、リモートテーブルに対して実行されているクエリを表すスクリプト可能オブジェクトに関する情報を取得するためのメソッドを提供します。

この API では、リモートテーブルプラグイン (com.glide.script.vtable) をアクティブ化する必要があります。 詳細については、「 リモートテーブルとスクリプトを使用した外部データの取得」を参照してください。

リモートテーブルの行は、v_table API を使用して作成されます。

v_query - getCondition(文字列 field)

指定されたフィールドのエンコードされたクエリー文字列を取得します。

「v_table API」も参照してください。

表 : 1. パラメーター

名前	タイプ	説明
フィールド	文字列	フィールドの名前

表 : 2. 返される内容

タイプ	説明
文字列	指定されたフィールドの エンコードされたクエリ文字列 を返します。

次の例は、number=INC0001^active=true のエンコードされたクエリーを使用したフィールドの結果を示しています。

var result = v_query.getCondition("number");
gs.info(result);

出力:

number=INC0001

v_query - getEncodedQuery()

リモートテーブルに対するクエリーをエンコードされたクエリー文字列として返します。

詳しくは、 エンコードされたクエリ文字列 を参照してください。

「v_table API」も参照してください。

表 : 3. パラメーター

名前	タイプ	説明
なし

表 : 4. 返される内容

タイプ	説明
文字列	文字列としてのエンコードクエリ。

次の例は、「 サードパーティソースから特定のレコードを取得する」のスニペットです。

gs.info(v_query.getEncodedQuery());

出力:

active=true^priority=1

v_query - getParameter(文字列 field)

等価性クエリー条件のフィールドの値を取得します。

関連項目：

• サードパーティソースから特定のレコードを取得する
• v_table API

表 : 5. パラメーター

名前	タイプ	説明
フィールド	文字列	クエリーするフィールドの名前。

表 : 6. 返される内容

タイプ	説明
文字列	クエリー条件のフィールドの値。例えば、name=John がエンコードされたクエリーの場合、getParameter("name") は "John"を返します。

次の例では、発信者 ID フィールドの値を取得する方法を示します。

v_query.getParameter("caller_id");

出力:

12345123451234512345123451234501

v_query - getSysId()

get クエリーの sys_id 値を返します。

表 : 7. パラメーター

名前	タイプ	説明
なし

表 : 8. 返される内容

タイプ	説明
文字列	get クエリーの sys_id 値。例えば、sys_id=123 の場合、このメソッドは 123 を返します。

次の例は、「 サードパーティソースから特定のレコードを取得する」のスニペットです。

v_query.getSysId();

出力:

a3a7ffb6dba41010db2051735e4619b7

v_query - getTextSearch()

テキスト検索クエリーのパラメーターを取得します。

関連項目：

• エンコードされたクエリ文字列
• スクリプトでのテーブルのクエリ
• v_table API

表 : 9. パラメーター

名前	タイプ	説明
なし

表 : 10. 返される内容

タイプ	説明
文字列	テキスト検索クエリーのパラメーター (例：email)。

次の例では、クエリーに GOTO123TEXTQUERY321=email などのテキストクエリーのパラメーターが含まれている場合、メソッドは true を返します。

// for query value GOTO123TEXTQUERY321=email
v_query.getTextSearch();

出力：

email

v_query - isGet()

クエリーが get クエリー、つまり sys_id ごとにレコードを取得するクエリーかどうかを決定します。

関連項目：

• サードパーティソースから特定のレコードを取得する
• v_table API

表 : 11. パラメーター

名前	タイプ	説明
なし

表 : 12. 返される内容

タイプ	説明
ブーリアン	フラグは、特定のレコードのクエリーにクエリー形式として sys_id= があることを示します。 有効な値： true：クエリーの sys_id フィールドに等価性クエリー条件が含まれている。 false：クエリーの sys_id フィールドに等価性クエリー条件が含まれていない。

次の例では、エンコードされたクエリーが sys_id=d1954c744662010bd7e061e67a6776eの場合、v_query.isGet() メソッドは true を返します。エンコードされたクエリーがそれ以外 (Number=INC0000001 など) の場合、v_query.isGet() メソッドは false を返します。

// Virtual table to query
var row = {
 sys_id: "d1954c744662010bd7e061e67a6776e",
 number: "INC0000001",
 short_description: "New laptop request",
 u_balance: 1200.23
};

v_table.addRow(row);

v_query.isGet();

v_query - isTextSearch()

クエリーにテキストクエリーのパラメーターが含まれているかどうかを示します。

関連項目：

• エンコードされたクエリ文字列
• スクリプトでのテーブルのクエリ
• v_table API

表 : 13. パラメーター

名前	タイプ	説明
なし

表 : 14. 返される内容

タイプ	説明
ブーリアン	クエリーにテキストクエリーのパラメーターが含まれているかどうかを示すフラグ。 有効な値： true：クエリーにテキストクエリーのパラメーターが含まれている。 false：クエリーにテキストクエリーのパラメーターが含まれていない。

次の例では、クエリーに GOTO123TEXTQUERY321=email などのテキストクエリーのパラメーターが含まれている場合、メソッドは true を返します。

v_query.isTextSearch();

v_query - setLastErrorMessage(文字列 message)

GlideRecord の最後のエラーメッセージを設定します。

関連項目：

• スコープ対象 GlideRecord - getLastErrorMessage()
• サードパーティソースから特定のレコードを取得する
• v_table API

表 : 15. パラメーター

名前	タイプ	説明
message	文字列	エラーメッセージ。

表 : 16. 返される内容

タイプ	説明
なし

次の例は、エラーメッセージを設定するために使用される基本構造を示しています。

(function executeQuery (v_table, v_query) {
 try {

 // Add code to test for errors during execution
 } catch(ex) {

  v_query.setLastErrorMessage(ex.message);

 }

}) (v_table, v_query);

次の例は、REST API で最後のエラーメッセージを設定する方法を示しています。

(function executeQuery (v_table, v_query) { 
 try {

 // call a REST API
 } catch(ex) {

  v_query.setLastErrorMessage("Error obtaining results from remote service");

 }

}) (v_table, v_query);