GlideListV3 (g_list) – Client (Veraltet)

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 7 Minuten Lesedauer

    • Die GlideListV3 API stellt Methoden zum Bearbeiten von Listen bereit.

    Sie greifen auf zu GlideListV3 Methoden mit G_list Globales Objekt. Diese Methoden werden in UI-Kontextmenüs und UI-Aktionen verwendet. Das Objekt „g_list“ ist für zugehörige Listen in der UI-Aktion „Formularlink“ nicht verfügbar.

    Hinweis:

    Diese API wird nicht mehr unterstützt. Erwägen Sie die Verwendung von GlideList2() API stattdessen.

    GlideListV3 – addFilter(Zeichenfolgenfilter)

    Fügt dem Listenabfragefilter einen einzelnen Begriff hinzu.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Filter Zeichenfolge Hinzuzufügende Abfragezeichenfolgenbedingung.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – GET(Zeichenfolge listId)

    Gibt das GlideList-Objekt für die angegebene Liste zurück.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    listId Zeichenfolge Der Listenname.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Objekt Das GlideList-Objekt für die angegebene Liste oder null, wenn nicht gefunden.

    GlideListV3 – GET(Object DomElement)

    Gibt das GlideList-Objekt für das angegebene DOM-Element zurück.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Domelement Objekt Die DOM-Element-ID, für das Sie das GlideList-Objekt verwenden möchten.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Objekt Das GlideList-Objekt für das angegebene DOM-Element. Gibt Null zurück, wenn das DOM-Element nicht gefunden wird.

    GlideListV3 – getChecked()

    Gibt eine kommagetrennte Liste von sys_IDs für aktivierte Elemente in der Liste zurück. Gibt keine Elemente zurück, die nicht ausgeführt werden dürfen.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Zeichenfolge Kommagetrennte Liste der sys_IDs für aktivierte Elemente in der Liste. Gibt keine Elemente zurück, die nicht ausgeführt werden dürfen.

    GlideListV3 – getFixedQuery()

    Gibt die Abfrage „sysparm_fixed“ zurück.

    Die feste Abfrage ist der Teil der Abfrage, der nicht aus dem Breadcrumb entfernt werden kann (d. h. sie ist für den Anwender behoben). Sie wird durch einschließlich angegeben sysparm_fixed_queryParameter für das Anwendungsmodul.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Zeichenfolge Die feste Abfragezeichenfolge für die Liste.

    GlideListV3 – getFormTarget()

    Gibt das Zielattribut des Formulars zurück.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Zeichenfolge Das Zielattribut des Formulars.

    GlideListV3 – getGroupBy()

    Gibt das Feld oder die kommagetrennte Liste von Feldern zurück, die zum Gruppieren der Liste verwendet werden.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Rückgaben
    Typ Beschreibung
    Zeichenfolge Das Feld oder die kommagetrennte Liste von Feldern, die zum Gruppieren der Liste verwendet werden.

    GlideListV3 – getListName()

    Gibt den Namen der Liste zurück, der normalerweise der Tabellenname ist.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 16. Rückgaben
    Typ Beschreibung
    Zeichenfolge Der Listenname.

    GlideListV3 – getOrderBy()

    Gibt das erste Feld zurück, das zum Sortieren der Liste verwendet wird.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Rückgaben
    Typ Beschreibung
    Zeichenfolge Das Feld, das zum Sortieren der Liste verwendet wird, oder eine leere Zeichenfolge, wenn die Liste nicht sortiert ist.

    GlideListV3 – getParentTable()

    Gibt den Namen der übergeordneten Tabelle zurück (die dem Formular zugeordnete Tabelle).

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 20. Rückgaben
    Typ Beschreibung
    Zeichenfolge Der Name der übergeordneten Tabelle.

    GlideListV3 – getQuery(Objektoptionen)

    Gibt die codierte Abfragezeichenfolge für die Liste zurück.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Optionen Objekt Die Optionen können eine oder mehrere der folgenden sein.
    • orderby: ORDERBY in die Abfrage einbeziehen
    • Groupby: GROUPBY in die Abfrage einschließen
    • Behoben: Schließen Sie sysparm_fixed_query in die Abfrage ein
    • Alle: Schließen Sie alle Optionen in die Abfrage ein
    Tabelle : 22. Rückgaben
    Typ Beschreibung
    Zeichenfolge Codierte Abfragezeichenfolge für die Liste.

    GlideListV3 – getReferringUrl()

    Gibt die verweisende URL zurück.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 24. Rückgaben
    Typ Beschreibung
    Zeichenfolge Gibt die URL des übergeordneten Formulars oder „*“ zurück, wenn kein übergeordnetes Formular vorhanden ist.

    GlideListV3 – getRelated()

    Gibt das zugehörige Listenfeld zurück, das die zugehörige Liste dem übergeordneten Formular zuordnet.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 26. Rückgaben
    Typ Beschreibung
    Zeichenfolge Feld, das die Liste mit dem übergeordneten Formular verbindet.

    GlideListV3 – getRelatedListType()

    Gibt den zugehörigen Listentyp zurück.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 28. Rückgaben
    Typ Beschreibung
    Zeichenfolge Der Beziehungstabellentyp.

    GlideListV3 – getRelationshipId()

    Gibt die Beziehungsdatensatz-ID zurück, wenn es sich um eine zugehörige Liste vom Typ „REL“ handelt.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 30. Rückgaben
    Typ Beschreibung
    Zeichenfolge Die sys_ID des Beziehungsdatensatzes.

    GlideListV3 – getRowCount()

    Gibt die Anzahl der von der Abfrage zurückgegebenen Zeilen zurück.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 32. Rückgaben
    Typ Beschreibung
    Nummer Die Anzahl der von der Abfrage zurückgegebenen Zeilen.

    GlideListV3 – getRowsPerPage()

    Gibt die Anzahl der Zeilen zurück, die auf einer Seite angezeigt werden sollen.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 34. Rückgaben
    Typ Beschreibung
    Nummer Die Anzahl der Zeilen, die auf einer Seite angezeigt werden sollen.

    GlideListV3 – getTableName()

    Gibt den Tabellennamen der Liste zurück.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 36. Rückgaben
    Typ Beschreibung
    Zeichenfolge Der Tabellenname der Liste.

    GlideListV3 – getTitle()

    Gibt den Listentitel zurück.

    Tabelle : 37. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 38. Rückgaben
    Typ Beschreibung
    Zeichenfolge Der Listentitel.

    GlideListV3 – getView()

    Gibt die Ansicht zurück, die zum Anzeigen der Liste verwendet wird.

    Tabelle : 39. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 40. Rückgaben
    Typ Beschreibung
    Zeichenfolge Der Name der Ansicht

    GlideListV3 – isUserList()

    Gibt „wahr“ zurück, wenn die Liste vom Anwender personalisiert wurde.

    Tabelle : 41. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 42. Rückgaben
    Typ Beschreibung
    Boolean „Wahr“, wenn sich das Listenlayout geändert hat.

    GlideListV3 – REFRESH(Nummer firstRow, Objekt additionalParams)

    Aktualisiert die Liste. Der orderBy-Teil des Listenfilters wird ignoriert, sodass die natürliche Reihenfolge der Liste verwendet wird.

    Tabelle : 43. Parameter
    Name Typ Beschreibung
    Erste Zeile Nummer (Optional) die erste Zeile, die in der Liste angezeigt werden soll. Wenn nicht angegeben, wird die aktuelle erste Zeile der Liste verwendet.
    additionalParams Objekt (Optional) Name: Wertpaare, die mit der Listenaktualisierungsanforderung übermittelt werden.
    Tabelle : 44. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – refreshWithOrderBy(Nummer firstRow, Objekt additionalParams)

    Aktualisiert die Liste mithilfe der orderBy-Felder.

    Tabelle : 45. Parameter
    Name Typ Beschreibung
    Erste Zeile Nummer (Optional) die erste Zeile, die in der Liste angezeigt werden soll. Wenn nicht angegeben, wird die aktuelle erste Zeile der Liste verwendet.
    additionalParams Objekt (Optional) Name: Wertpaare, die mit der Listenaktualisierungsanforderung übermittelt werden.
    Tabelle : 46. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setFilter (Zeichenfolgenfilter, boolescher saveOrderBy, boolescher saveGroupBy)

    Legt die codierte Abfragezeichenfolge für die Liste fest, wobei die Teile „orderBy“ und „groupBy“ der Abfragezeichenfolge ignoriert werden.

    Tabelle : 47. Parameter
    Name Typ Beschreibung
    Filter Zeichenfolge Eine codierte Abfragezeichenfolge.
    SaveOrderBy Boolean Der Standardwert ist „falsch“. Bei „wahr“ wird der orderBy-Teil der Abfrage verwendet.
    SaveGroupBy Boolean Der Standardwert ist „falsch“. Bei „wahr“ wird der groupBy-Teil der Abfrage verwendet.
    Tabelle : 48. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setFilterAndRefresh( Zeichenfolgenfilter)

    Legt die codierte Abfragezeichenfolge für die Liste fest und aktualisiert die Liste dann mit dem neuen Filter.

    Dadurch werden die Parameter groupby und orderby beibehalten.

    Tabelle : 49. Parameter
    Name Typ Beschreibung
    Filter Zeichenfolge Codierte Abfragezeichenfolge.
    Tabelle : 50. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setFirstRow(Number firstRow)

    Legt die erste Zeile fest, die angezeigt werden soll, wenn die Liste aktualisiert wird.

    Tabelle : 51. Parameter
    Name Typ Beschreibung
    Erste Zeile Nummer Die Zeilennummer in der Liste.
    Tabelle : 52. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setFormTarget (Zeichenfolgenziel)

    Gibt an, wo die Antwort aus dem Formular angezeigt werden soll.

    Tabelle : 53. Parameter
    Name Typ Beschreibung
    Ziel Zeichenfolge Der zu verwendende Attributwert „Form.target“.
    Tabelle : 54. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setGroupBy(Zeichenfolge groupBy)

    Legt fest groupByKriterien für die Liste, für ein einzelnes Feld oder mehrere Felder.

    Verwenden Sie für ein einzelnes Feld Feld oder groupByField. Das groupBy-Präfix ist optional. Verwenden Sie für mehrere Felder feld1^field2^field3 Oder GroupByField1^groupByField2^groupByField3 .

    Tabelle : 55. Parameter
    Name Typ Beschreibung
    Zeichenfolge groupBy Die Gruppierungskriterien für die Liste.
    Tabelle : 56. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setOrderBy(Zeichenfolge orderBy)

    Legt fest orderByKriterien für die Liste.

    Für ein einzelnes Feld „Reihenfolge nach“ verwenden orderByFeld oder orderByDescField. Verwenden Sie für mehrere Felder SortierenNachFeld1^orderNachFeld2^orderNachFeld3 . orderByGibt eine aufsteigende Reihenfolge an, und reiderByDesc gibt eine absteigende Reihenfolge an. Diese Präfixzeichenfolgen sind optional. Wenn nicht angegeben orderByWird angenommen.

    Tabelle : 57. Parameter
    Name Typ Beschreibung
    orderBy Zeichenfolge Einzelne oder mehrere Felder für Sortieren nach.
    Tabelle : 58. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setReferringUrl(Zeichenfolgen-url)

    Legt die Referenz-url des übergeordneten Formulars fest.

    Tabelle : 59. Parameter
    Name Typ Beschreibung
    URL Zeichenfolge URL des übergeordneten Formulars
    Tabelle : 60. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – setRowsPerPage(Nummernnumzeilen)

    Legen Sie die Anzahl der Zeilen fest, die auf einer Seite angezeigt werden sollen.

    Tabelle : 61. Parameter
    Name Typ Beschreibung
    Zahlenzeilen Nummer Die Anzahl der Zeilen, die auf einer Seite angezeigt werden sollen.
    Tabelle : 62. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – showHideGroups (boolescher Wert „showFlag“)

    Blendet alle Gruppen in der Liste ein oder aus und speichert den aktuellen reduzierten/erweiterten Status der Gruppen als Anwendereinstellung.

    Tabelle : 63. Parameter
    Name Typ Beschreibung
    ShowFlag Boolean Bei „wahr“ werden die Gruppen in der Liste angezeigt.
    Tabelle : 64. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – showHideList (boolescher Wert „showFlag“)

    Blendet die Liste ein oder aus und speichert den aktuellen reduzierten/erweiterten Status der Liste als Anwendereinstellung.

    Tabelle : 65. Parameter
    Name Typ Beschreibung
    ShowFlag Boolean Bei „wahr“ wird die Liste angezeigt.
    Tabelle : 66. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – sort(Zeichenfolgenfeld)

    Sortieren Sie die Liste in aufsteigender Reihenfolge.

    Tabelle : 67. Parameter
    Name Typ Beschreibung
    Ausstehend Zeichenfolge Das Feld, das zum Sortieren der Liste verwendet werden soll.
    Tabelle : 68. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – sortDescending(Zeichenfolgenfeld)

    Sortiert die Liste in absteigender Reihenfolge.

    Tabelle : 69. Parameter
    Name Typ Beschreibung
    Ausstehend Zeichenfolge Das Feld, das zum Sortieren der Liste verwendet wird.
    Tabelle : 70. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – toggleList()

    Schaltet die Listenanzeige zwischen reduziert und erweitert um und speichert den Status als Anwendereinstellung.

    Tabelle : 71. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 72. Rückgaben
    Typ Beschreibung
    Ungültig

    GlideListV3 – toggleListNoPref()

    Schaltet die Listenanzeige zwischen reduziert und erweitert um, speichert den Status jedoch nicht als Anwendereinstellung.

    Tabelle : 73. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 74. Rückgaben
    Typ Beschreibung
    Ungültig