GlideListV3 (g_list): クライアント (非推奨)

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：10分

    • GlideListV3 API は、リストを操作するメソッドを提供します。

    GlideListV3 メソッドにアクセスするには、g_list グローバルオブジェクトを使用します。これらのメソッドは、UI コンテキストメニューと UI アクションで使用されます。g_list オブジェクトは、フォームリンク UI アクションの関連リストでは使用できません。

    注:

    この API のサポートは停止しています。代わりに GlideList2() API の使用を検討してください。

    GlideListV3 - addFilter(文字列 filter)

    単一の用語をクエリフィルターのリストに追加します。

    表 : 1. パラメーター
    名前 タイプ 説明
    filter 文字列 追加するクエリ文字列条件。
    表 : 2. 返される内容
    タイプ 説明
    なし

    GlideListV3 - get(文字列 listId)

    指定されたリストの GlideList オブジェクトを返します。

    表 : 3. パラメーター
    名前 タイプ 説明
    listId 文字列 リスト名。
    表 : 4. 返される内容
    タイプ 説明
    オブジェクト 指定されたリストの GlideList オブジェクト。見つからない場合は null。

    GlideListV3 - get(オブジェクト DomElement)

    指定された DOM 要素の GlideList オブジェクトを返します。

    表 : 5. パラメーター
    名前 タイプ 説明
    DomElement オブジェクト GlideList オブジェクトが必要な DOM 要素 ID。
    表 : 6. 返される内容
    タイプ 説明
    オブジェクト 指定された DOM 要素の GlideList オブジェクト。DOM 要素が見つからない場合は null を返します。

    GlideListV3 - getChecked()

    リストでチェックされたアイテムの sys_id のカンマ区切りリストを返します。実行が許可されていないアイテムは返されません。

    表 : 7. パラメーター
    名前 タイプ 説明
    なし
    表 : 8. 返される内容
    タイプ 説明
    文字列 リストでチェックされたアイテムの sys_id のカンマ区切りリスト。実行が許可されていないアイテムは返されません。

    GlideListV3 - getFixedQuery()

    sysparm_fixed クエリを返します。

    固定クエリはブレッドクラムから削除できない (つまり、ユーザーに対して固定されている) クエリの一部です。これは、アプリケーションモジュールの sysparm_fixed_query パラメーターを含めることで指定します。

    表 : 9. パラメーター
    名前 タイプ 説明
    なし
    表 : 10. 返される内容
    タイプ 説明
    文字列 リストの固定クエリ文字列。

    GlideListV3 - getFormTarget()

    フォームのターゲット属性を返します。

    表 : 11. パラメーター
    名前 タイプ 説明
    なし
    表 : 12. 返される内容
    タイプ 説明
    文字列 フォームのターゲット属性。

    GlideListV3 - getGroupBy()

    リストをグループ化するために使用されるフィールドまたはフィールドのカンマ区切りリストを返します。

    表 : 13. パラメーター
    名前 タイプ 説明
    なし
    表 : 14. 返される内容
    タイプ 説明
    文字列 リストをグループ化するために使用されるフィールドまたはフィールドのカンマ区切りリスト。

    GlideListV3 - getListName()

    通常はテーブル名であるリストの名前を返します。

    表 : 15. パラメーター
    名前 タイプ 説明
    なし
    表 : 16. 返される内容
    タイプ 説明
    文字列 リスト名。

    GlideListV3 - getOrderBy()

    リストの順序付けに使用される最初のフィールドを返します。

    表 : 17. パラメーター
    名前 タイプ 説明
    なし
    表 : 18. 返される内容
    タイプ 説明
    文字列 リストの順序付けに使用されるフィールド。リストがソートされていない場合は空の文字列。

    GlideListV3 - getParentTable()

    親テーブル (フォームに関連付けられているテーブル) の名前を返します。

    表 : 19. パラメーター
    名前 タイプ 説明
    なし
    表 : 20. 返される内容
    タイプ 説明
    文字列 親テーブル名。

    GlideListV3 - getQuery(オブジェクト options)

    リストのエンコードされたクエリ文字列を返します。

    表 : 21. パラメーター
    名前 タイプ 説明
    オプション オブジェクト options は次の 1 つ以上です。
    • orderby ：クエリに ORDERBY を含める
    • groupby：クエリに GROUPBY を含める
    • fixed：クエリに sysparm_fixed_query を含める
    • all：クエリにのすべての options を含める
    表 : 22. 返される内容
    タイプ 説明
    文字列 リストのエンコードされたクエリ文字列。

    GlideListV3 - getReferringUrl()

    参照 URL を返します。

    表 : 23. パラメーター
    名前 タイプ 説明
    なし
    表 : 24. 返される内容
    タイプ 説明
    文字列 親フォームの URL を返します。親フォームがない場合は「*」を返します。

    GlideListV3 - getRelated()

    関連リストを親フォームに関連付ける関連リストフィールドを返します。

    表 : 25. パラメーター
    名前 タイプ 説明
    なし
    表 : 26. 返される内容
    タイプ 説明
    文字列 リストを親フォームに接続するフィールド。

    GlideListV3 - getRelatedListType()

    関連リストタイプを返します。

    表 : 27. パラメーター
    名前 タイプ 説明
    なし
    表 : 28. 返される内容
    タイプ 説明
    文字列 リレーションシップテーブルタイプ。

    GlideListV3 - getRelationshipId()

    これが REL 関連リストの場合、リレーションシップレコード ID を返します。

    表 : 29. パラメーター
    名前 タイプ 説明
    なし
    表 : 30. 返される内容
    タイプ 説明
    文字列 リレーションシップレコードの sys_id。

    GlideListV3 - getRowCount()

    クエリによって返された行数を返します。

    表 : 31. パラメーター
    名前 タイプ 説明
    なし
    表 : 32. 返される内容
    タイプ 説明
    数値 クエリによって返された行数。

    GlideListV3 - getRowsPerPage()

    ページに表示する行数を返します。

    表 : 33. パラメーター
    名前 タイプ 説明
    なし
    表 : 34. 返される内容
    タイプ 説明
    数値 ページに表示する行数。

    GlideListV3 - getTableName()

    リストのテーブル名を返します。

    表 : 35. パラメーター
    名前 タイプ 説明
    なし
    表 : 36. 返される内容
    タイプ 説明
    文字列 リストのテーブル名。

    GlideListV3 - getTitle()

    リストのタイトルを返します。

    表 : 37. パラメーター
    名前 タイプ 説明
    なし
    表 : 38. 返される内容
    タイプ 説明
    文字列 リストのタイトル。

    GlideListV3 - getView()

    リストを表示するために使用するビューを返します。

    表 : 39. パラメーター
    名前 タイプ 説明
    なし
    表 : 40. 返される内容
    タイプ 説明
    文字列 ビューの名前。

    GlideListV3 - isUserList()

    リストがユーザーによってカスタマイズされている場合は true を返します。

    表 : 41. パラメーター
    名前 タイプ 説明
    なし
    表 : 42. 返される内容
    タイプ 説明
    ブーリアン リストのレイアウトが変更された場合は true。

    GlideListV3 - refresh(数値 firstRow, オブジェクト additionalParms)

    リストを更新します。リストフィルターの orderBy 部分は無視されるため、リストの自然な順序付けが使用されます。

    表 : 43. パラメーター
    名前 タイプ 説明
    firstRow 数値 (オプション) リストに表示する最初の行。指定しない場合、リストの現在の最初の行が使用されます。
    additionalParams オブジェクト (オプション) リスト更新要求で送信される名前と値のペア。
    表 : 44. 返される内容
    タイプ 説明
    なし

    GlideListV3 - refreshWithOrderBy(数値 firstRow, オブジェクト additionalParms)

    [orderBy] フィールドを使用してリストを更新します。

    表 : 45. パラメーター
    名前 タイプ 説明
    firstRow 数値 (オプション) リストに表示する最初の行。指定しない場合、リストの現在の最初の行が使用されます。
    additionalParams オブジェクト (オプション) リスト更新要求で送信される名前と値のペア。
    表 : 46. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setFilter(文字列 filter, ブーリアン saveOrderBy, ブーリアン saveGroupBy)

    クエリ文字列の orderBy および groupBy 部分を無視して、リストのエンコードされたクエリ文字列を設定します。

    表 : 47. パラメーター
    名前 タイプ 説明
    filter 文字列 エンコードされたクエリ文字列。
    saveOrderBy ブーリアン デフォルト値は false です。true の場合、クエリの orderBy 部分を使用します。
    saveGroupBy ブーリアン デフォルト値は false です。true の場合、クエリの groupBy 部分を使用します。
    表 : 48. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setFilterAndRefresh(文字列 filter)

    リストのエンコードされたクエリ文字列を設定し、新しいフィルターを使用してリストを更新します。

    これにより、groupby パラメーターと orderby パラメーターが保持されます。

    表 : 49. パラメーター
    名前 タイプ 説明
    filter 文字列 エンコードされたクエリ文字列。
    表 : 50. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setFirstRow(数値 firstRow)

    リストが更新されたときに表示される最初の行を設定します。

    表 : 51. パラメーター
    名前 タイプ 説明
    firstRow 数値 リスト内の行番号。
    表 : 52. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setFormTarget(文字列 target)

    フォームからの応答を表示する場所を指定します。

    表 : 53. パラメーター
    名前 タイプ 説明
    target 文字列 使用する form.target 属性値。
    表 : 54. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setGroupBy(文字列 groupBy)

    単一のフィールドまたは複数のフィールドに対して、リストの groupBy 条件を設定します。

    単一のフィールドの場合は、field または groupByField を使用します。groupBy プリフィックスはオプションです。複数のフィールドの場合は、field1^field2^field3 または groupByField1^groupByField2^groupByField3 を使用します。

    表 : 55. パラメーター
    名前 タイプ 説明
    文字列 groupBy リストのグループ化条件。
    表 : 56. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setOrderBy(文字列 orderBy)

    リストの orderBy 条件を設定します。

    単一の順序付けフィールドの場合は、orderBy フィールドまたは orderByDescField を使用します。複数のフィールドの場合は、orderByField1^orderByField2^orderByField3 を使用します。orderBy は昇順を指定し、orderByDesc は降順を指定します。これらのプレフィックス文字列はオプションです。指定しない場合、orderBy と想定されます。

    表 : 57. パラメーター
    名前 タイプ 説明
    orderBy 文字列 単一または複数の順序フィールド。
    表 : 58. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setReferringUrl(文字列 url)

    親フォームの参照 URL を設定します。

    表 : 59. パラメーター
    名前 タイプ 説明
    url 文字列 親フォームの URL。
    表 : 60. 返される内容
    タイプ 説明
    なし

    GlideListV3 - setRowsPerPage(数値 numRows)

    ページに表示する行数を設定します。

    表 : 61. パラメーター
    名前 タイプ 説明
    numRows 数値 ページに表示する行数。
    表 : 62. 返される内容
    タイプ 説明
    なし

    GlideListV3 - showHideGroups(ブーリアン showFlag)

    リスト内のすべてのグループを表示または非表示にし、グループの現在の折りたたみ/展開ステータスをユーザー初期設定として保存します。

    表 : 63. パラメーター
    名前 タイプ 説明
    showFlag ブーリアン true の場合、リスト内のグループを表示します。
    表 : 64. 返される内容
    タイプ 説明
    なし

    GlideListV3 - showHideList(ブーリアン showFlag)

    リストを表示または非表示にし、リストの現在の折りたたみ/展開ステータスをユーザー初期設定として保存します。

    表 : 65. パラメーター
    名前 タイプ 説明
    showFlag ブーリアン true の場合、リストを表示します。
    表 : 66. 返される内容
    タイプ 説明
    なし

    GlideListV3 - sort(文字列 field)

    リストを昇順でソートします。

    表 : 67. パラメーター
    名前 タイプ 説明
    フィールド 文字列 リストのソートに使用するフィールド。
    表 : 68. 返される内容
    タイプ 説明
    なし

    GlideListV3 - sortDescending(文字列 field)

    リストを降順でソートします

    表 : 69. パラメーター
    名前 タイプ 説明
    フィールド 文字列 リストのソートに使用するフィールド。
    表 : 70. 返される内容
    タイプ 説明
    なし

    GlideListV3 - toggleList()

    リストの表示を折りたたみと展開で切り替えて、ステータスをユーザー初期設定として保存します。

    表 : 71. パラメーター
    名前 タイプ 説明
    なし
    表 : 72. 返される内容
    タイプ 説明
    なし

    GlideListV3 - toggleListNoPref()

    リストの表示を折りたたみと展開で切り替えますが、ステータスをユーザー初期設定として保存しません。

    表 : 73. パラメーター
    名前 タイプ 説明
    なし
    表 : 74. 返される内容
    タイプ 説明
    なし