GlideListV3 (g_list) – Client (veraltet)

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 7 Minuten Lesedauer

    • Die GlideListV3- API bietet Methoden zum Bearbeiten von Listen.

    Sie greifen auf die GlideListV3- Methoden zu, indem Sie das globale Objekt „g_list“ verwenden. Diese Methoden werden in UI-Kontextmenüs und UI Actions verwendet. Das Objekt „g_list“ ist für zugehörige Listen in der UI Action für den Formular-Link nicht verfügbar.

    Hinweis:

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

    GlideListV3 – addFilter(String filter)

    Fügt dem Listenabfragefilter einen einzelnen Begriff hinzu.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Abfragezeichenfolge-Bedingung, die hinzugefügt werden soll.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – get(String listId)

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

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    listId Zeichenfolge Listenname.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt Das GlideList-Objekt für die angegebene Liste oder NULL, falls 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 DOM-Element-ID, für die Sie das GlideList-Objekt benötigen.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt GlideList-Objekt für das angegebene DOM-Element. Gibt NULL zurück, wenn das DOM-Element nicht gefunden wurde.

    GlideListV3 – getChecked()

    Gibt eine kommagetrennte Liste mit sys_ids für die geprüften 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. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Kommagetrennte Liste mit sys_ids für geprüfte 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. für den Benutzer festgelegt). Sie wird durch Einschließen des Parameters sysparm_fixed_query für das Anwendungsmodul angegeben.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feste Abfragezeichenfolge für die Liste.

    GlideListV3 – getFormTarget()

    Gibt das Zielattribut des Formulars zurück.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Zielattribut des Formulars.

    GlideListV3 – getGroupBy()

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

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Feld oder kommagetrennte Liste mit Feldern, die zum Gruppieren der Liste verwendet werden.

    GlideListV3 – getListName()

    Gibt den Namen der Liste zurück, normalerweise den Tabellennamen.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Zeichenfolge 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. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Das zum Sortieren der Liste verwendete Feld oder eine leere Zeichenfolge, wenn die Liste nicht sortiert ist.

    GlideListV3 – getParentTable()

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

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der übergeordneten Tabelle.

    GlideListV3 – getQuery(Object options)

    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 der Abfrage einschließen
    • groupby: GROUPBY in der Abfrage einschließen
    • fixed: sysparm_fixed_query in der Abfrage einschließen
    • all: alle Optionen in der Abfrage einschließen
    Tabelle : 22. Ergebnisse
    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. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Gibt die URL des übergeordneten Formulars oder „*“ zurück, wenn kein übergeordnetes Formular vorhanden ist.

    GlideListV3 – getRelated()

    Gibt das verknüpfte Listenfeld zurück, das die verknüpfte Liste dem übergeordneten Formular zuordnet.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 26. Ergebnisse
    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. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Typ der Beziehungstabelle.

    GlideListV3 – getRelationshipId()

    Gibt die Beziehungsdatensatz-ID zurück, wenn es sich um eine verknüpfte Liste vom Typ REL handelt.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    Zeichenfolge 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. Ergebnisse
    Typ Beschreibung
    Zahl 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. Ergebnisse
    Typ Beschreibung
    Zahl 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. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Tabellenname der Liste.

    GlideListV3 – getTitle()

    Gibt den Listentitel zurück.

    Tabelle : 37. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 38. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Listentitel.

    GlideListV3 – getView()

    Gibt die Ansicht zurück, mit der die Liste angezeigt wurde.

    Tabelle : 39. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 40. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Name der Ansicht.

    GlideListV3 – isUserList()

    Gibt „true“ zurück, wenn die Liste vom Benutzer personalisiert wurde.

    Tabelle : 41. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 42. Ergebnisse
    Typ Beschreibung
    Boolean „True“, wenn sich das Listenlayout geändert hat.

    GlideListV3 – refresh(Number firstRow, Object 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
    firstRow Zahl (Optional) Erste Zeile, die in der Liste angezeigt werden soll. Wenn nicht angegeben, wird die aktuelle erste Zeile der Liste verwendet.
    additionalParams Objekt (Optional) Name-Wert-Paare, die mit der Listenaktualisierungsanforderung übermittelt werden.
    Tabelle : 44. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – refreshWithOrderBy(Number firstRow, Object additionalParams)

    Aktualisiert die Liste mit den orderBy-Feldern.

    Tabelle : 45. Parameter
    Name Typ Beschreibung
    firstRow Zahl (Optional) Erste Zeile, die in der Liste angezeigt werden soll. Wenn nicht angegeben, wird die aktuelle erste Zeile der Liste verwendet.
    additionalParams Objekt (Optional) Name-Wert-Paare, die mit der Listenaktualisierungsanforderung übermittelt werden.
    Tabelle : 46. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setFilter(String filter, Boolean saveOrderBy, Boolean saveGroupBy)

    Legt die codierte Abfragezeichenfolge für die Liste fest und ignoriert die orderby- und groupby-Teile der Abfragezeichenfolge.

    Tabelle : 47. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Verschlüsselte Abfragezeichenfolge.
    saveOrderBy Boolean Der Standardwert ist „false“. Bei „true“ wird der orderBy-Teil der Abfrage verwendet.
    saveGroupBy Boolean Der Standardwert ist „false“. Bei „true“ wird der groupBy-Teil der Abfrage verwendet.
    Tabelle : 48. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setFilterAndRefresh( String filter)

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

    Dadurch bleiben die Parameter „groupby“ und „orderby“ erhalten.

    Tabelle : 49. Parameter
    Name Typ Beschreibung
    filter Zeichenfolge Codierte Abfragezeichenfolge.
    Tabelle : 50. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setFirstRow(Number firstRow)

    Legt die erste anzuzeigende Zeile fest, wenn die Liste aktualisiert wird.

    Tabelle : 51. Parameter
    Name Typ Beschreibung
    firstRow Zahl Zeilennummer in der Liste.
    Tabelle : 52. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setFormTarget(String target)

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

    Tabelle : 53. Parameter
    Name Typ Beschreibung
    target Zeichenfolge Zu verwendender „form.target“-Attributwert.
    Tabelle : 54. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setGroupBy(String groupBy)

    Legt die Kriterien groupBy für die Liste für ein einzelnes Feld oder mehrere Felder fest.

    Verwenden Sie für ein einzelnes Feld „field“ oder „groupByField“. Das groupBy-Präfix ist optional. Verwenden Sie für mehrere Felder field1^field2^field3 oder groupByField1^groupByField2^groupByField3.

    Tabelle : 55. Parameter
    Name Typ Beschreibung
    Zeichenfolge groupBy Gruppe nach Kriterien für die Liste.
    Tabelle : 56. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setOrderBy(String orderBy)

    Legt die Kriterien orderBy für die Liste fest.

    Für ein einzelnes Feld vom Typ „Sortieren nach“ verwenden Sie das Feld orderBy oder orderByDescField. Verwenden Sie für mehrere Felder orderByField1^orderByField2^orderByField3. orderBy gibt die aufsteigende Reihenfolge und orderByDesc die absteigende Reihenfolge an. Diese Präfixzeichenfolgen sind optional. Wenn nicht angegeben, wird von orderBy ausgegangen.

    Tabelle : 57. Parameter
    Name Typ Beschreibung
    orderBy Zeichenfolge Einzelne oder mehrfache Sortierung nach Feldern.
    Tabelle : 58. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setReferringUrl(String url)

    Legt die verweisende URL des übergeordneten Formulars fest.

    Tabelle : 59. Parameter
    Name Typ Beschreibung
    URL Zeichenfolge URL des übergeordneten Formulars
    Tabelle : 60. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – setRowsPerPage(Number numRows)

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

    Tabelle : 61. Parameter
    Name Typ Beschreibung
    numRows Zahl Anzahl der Zeilen, die auf einer Seite angezeigt werden sollen.
    Tabelle : 62. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – showHideGroups(Boolean showFlag)

    Zeigt alle Gruppen in der Liste an oder blendet sie aus und speichert den aktuellen reduzierten/erweiterten Status der Gruppen als Benutzervoreineinstellung.

    Tabelle : 63. Parameter
    Name Typ Beschreibung
    showFlag Boolean Bei „true“ werden die Gruppen in der Liste angezeigt.
    Tabelle : 64. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – showHideList(Boolean showFlag)

    Zeigt die Liste an oder blendet sie aus und speichert den aktuellen reduzierten/erweiterten Status der Liste als Benutzervoreinstellung.

    Tabelle : 65. Parameter
    Name Typ Beschreibung
    showFlag Boolean Bei „true“ wird die Liste angezeigt.
    Tabelle : 66. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – sort(String field)

    Sortiert die Liste in aufsteigender Reihenfolge.

    Tabelle : 67. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Feld für das Sortieren der Liste.
    Tabelle : 68. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – sortDescending(String field)

    Sortiert die Liste in absteigender Reihenfolge.

    Tabelle : 69. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Feld zum Sortieren der Liste.
    Tabelle : 70. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – toggleList()

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

    Tabelle : 71. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 72. Ergebnisse
    Typ Beschreibung
    void

    GlideListV3 – toggleListNoPref()

    Schaltet die Listenanzeige zwischen reduziert und erweitert um, speichert den Status aber nicht als Benutzervoreinstellung.

    Tabelle : 73. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 74. Ergebnisse
    Typ Beschreibung
    void