GlideListV3 (g_list) : client (déconseillé)

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 7 minutes de lecture

    • L’API GlideListV3 fournit des méthodes pour manipuler les listes.

    Vous accédez aux méthodes GlideListV3 à l’aide de l’objet global g_list . Ces méthodes sont utilisées dans les menus contextuels et les actions d’interface utilisateur. L’objet g_list n’est pas disponible pour les listes associées sur l’action d’interface utilisateur du lien du formulaire.

    Remarque :

    Cette API n’est plus prise en charge. Envisagez plutôt d’utiliser l’API GlideList2().

    GlideListV3 : addFilter(filtre de chaîne)

    Ajoute un terme unique au filtre de requête de liste.

    Tableau 1. Paramètres
    Nom Type Description
    filtre Chaîne Condition de chaîne de requête à ajouter.
    Tableau 2. Renvoie
    Type Description
    nul

    GlideListV3 : get(String listId)

    Renvoie l’objet GlideList pour la liste spécifiée.

    Tableau 3. Paramètres
    Nom Type Description
    listId Chaîne Nom de la liste.
    Tableau 4. Renvoie
    Type Description
    Objet Objet GlideList pour la liste spécifiée ou nul si introuvable.

    GlideListV3 : get(Objet DomElement)

    Renvoie l’objet GlideList pour l’élément DOM spécifié.

    Tableau 5. Paramètres
    Nom Type Description
    Élément de Dom Objet ID de l’élément DOM pour lequel vous souhaitez l’objet GlideList.
    Tableau 6. Renvoie
    Type Description
    Objet L’objet GlideList pour l’élément DOM spécifié. Renvoie null si l’élément DOM est introuvable.

    GlideListV3 : getChecked()

    Renvoie une liste de sys_ids séparés par des virgules pour les éléments vérifiés de la liste. Ne renvoie pas les éléments dont l’exécution n’est pas autorisée.

    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    Chaîne Liste séparée par des virgules des sys_ids pour les éléments vérifiés de la liste. Ne renvoie pas les éléments dont l’exécution n’est pas autorisée.

    GlideListV3 : getFixedQuery()

    Renvoie la requête sysparm_fixed.

    La requête fixe est la partie de la requête qui ne peut pas être supprimée du fil d’Ariane (c’est-à-dire qu’elle est fixe pour l’utilisateur). Cela se spécifie en incluant un sysparm_fixed_query paramètre pour le module d’application.

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    Chaîne Chaîne de requête fixe pour la liste.

    GlideListV3 : getFormTarget()

    Renvoie l’attribut cible du formulaire.

    Tableau 11. Paramètres
    Nom Type Description
    Aucun
    Tableau 12. Renvoie
    Type Description
    Chaîne L’attribut cible du formulaire.

    GlideListV3 : getGroupBy()

    Renvoie la liste des champs ou des champs séparés par des virgules utilisés pour regrouper la liste.

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    Chaîne Liste des champs séparés par des champs ou séparés par des virgules utilisés pour regrouper la liste.

    GlideListV3 : getListName()

    Renvoie le nom de la liste, qui est généralement le nom de la table.

    Tableau 15. Paramètres
    Nom Type Description
    Aucun
    Tableau 16. Renvoie
    Type Description
    Chaîne Nom de la liste.

    GlideListV3 : getOrderBy()

    Renvoie le premier champ utilisé pour organiser la liste.

    Tableau 17. Paramètres
    Nom Type Description
    Aucun
    Tableau 18. Renvoie
    Type Description
    Chaîne Champ utilisé pour ordonner la liste, ou chaîne vide si la liste n’est pas triée.

    GlideListV3 : getParentTable()

    Renvoie le nom de la table parente (la table associée au formulaire).

    Tableau 19. Paramètres
    Nom Type Description
    Aucun
    Tableau 20. Renvoie
    Type Description
    Chaîne Nom de la table parente.

    GlideListV3 : getQuery(options d’objet)

    Renvoie la chaîne de requête codée pour la liste.

    Tableau 21. Paramètres
    Nom Type Description
    options Objet Les options peuvent être une ou plusieurs des options suivantes.
    • orderby : inclure ORDERBY dans la requête
    • groupby : inclut GROUPBY dans la requête
    • Fixe : inclure sysparm_fixed_query dans la requête
    • Tout : inclure toutes les options dans la requête
    Tableau 22. Renvoie
    Type Description
    Chaîne Chaîne de requête codée pour la liste.

    GlideListV3 : getReferringUrl()

    Renvoie l’URL de référence.

    Tableau 23. Paramètres
    Nom Type Description
    Aucun
    Tableau 24. Renvoie
    Type Description
    Chaîne Renvoie l’URL du formulaire parent, ou « * » s’il n’existe pas de formulaire parent.

    GlideListV3 : getRelated()

    Renvoie le champ de liste connexe qui associe la liste connexe au formulaire parent.

    Tableau 25. Paramètres
    Nom Type Description
    Aucun
    Tableau 26. Renvoie
    Type Description
    Chaîne Champ qui relie la liste au formulaire parent.

    GlideListV3 : getRelatedListType()

    Renvoie le type de liste connexe.

    Tableau 27. Paramètres
    Nom Type Description
    Aucun
    Tableau 28. Renvoie
    Type Description
    Chaîne Le type de table de relations.

    GlideListV3 : getRelationshipId()

    Renvoie l’ID d’enregistrement de relation, s’il s’agit de la liste connexe de type REL.

    Tableau 29. Paramètres
    Nom Type Description
    Aucun
    Tableau 30. Renvoie
    Type Description
    Chaîne Le sys_id de l’enregistrement de la relation.

    GlideListV3 : getRowCount()

    Renvoie le nombre de lignes renvoyées par la requête.

    Tableau 31. Paramètres
    Nom Type Description
    Aucun
    Tableau 32. Renvoie
    Type Description
    Numéro Nombre de lignes renvoyées par la requête.

    GlideListV3 : getRowsPerPage()

    Renvoie le nombre de lignes à afficher sur une page.

    Tableau 33. Paramètres
    Nom Type Description
    Aucun
    Tableau 34. Renvoie
    Type Description
    Numéro Nombre de lignes à afficher sur une page.

    GlideListV3 : getTableName()

    Renvoie le nom de table de la liste.

    Tableau 35. Paramètres
    Nom Type Description
    Aucun
    Tableau 36. Renvoie
    Type Description
    Chaîne Nom de table de la liste.

    GlideListV3 : getTitle()

    Renvoie le titre de la liste.

    Tableau 37. Paramètres
    Nom Type Description
    Aucun
    Tableau 38. Renvoie
    Type Description
    Chaîne Le titre de la liste.

    GlideListV3 : getView()

    Renvoie la vue utilisée pour afficher la liste.

    Tableau 39. Paramètres
    Nom Type Description
    Aucun
    Tableau 40. Renvoie
    Type Description
    Chaîne Nom de la vue

    GlideListV3 : isUserList()

    Renvoie la valeur true si la liste a été personnalisée par l’utilisateur.

    Tableau 41. Paramètres
    Nom Type Description
    Aucun
    Tableau 42. Renvoie
    Type Description
    Booléen Vrai si la mise en page de la liste a changé.

    GlideListV3 : refresh(Numéro, firstRow, Object, additionalParams)

    Actualise la liste. La partie orderBy du filtre de liste est ignorée afin que l’ordre naturel de la liste soit utilisé.

    Tableau 43. Paramètres
    Nom Type Description
    première ligne Numéro (Facultatif) Première ligne à afficher dans la liste. Si elle n’est pas spécifiée, la première ligne actuelle de la liste est utilisée.
    additionalParams Objet (Facultatif) Paires nom-valeur soumises avec la demande d’actualisation de la liste.
    Tableau 44. Renvoie
    Type Description
    nul

    GlideListV3 : refreshWithOrderBy(Numéro, première ligne, objet additionalParams)

    Actualise la liste à l’aide des champs orderBy.

    Tableau 45. Paramètres
    Nom Type Description
    première ligne Numéro (Facultatif) Première ligne à afficher dans la liste. Si elle n’est pas spécifiée, la première ligne actuelle de la liste est utilisée.
    additionalParams Objet (Facultatif) Paires nom-valeur soumises avec la demande d’actualisation de la liste.
    Tableau 46. Renvoie
    Type Description
    nul

    GlideListV3 : setFilter(filtre de chaîne, booléen saveOrderBy, booléen saveGroupBy)

    Définit la chaîne de requête codée pour la liste en ignorant les parties orderBy et groupBy de la chaîne de requête.

    Tableau 47. Paramètres
    Nom Type Description
    filtre Chaîne Une chaîne de requête codée.
    saveOrderBy Booléen La valeur par défaut est faux. Si la valeur est vrai, la partie orderBy de la requête est utilisée.
    saveGroupBy Booléen La valeur par défaut est faux. Si la valeur est vrai, la partie groupBy de la requête est utilisée.
    Tableau 48. Renvoie
    Type Description
    nul

    GlideListV3 : setFilterAndRefresh(filtre de chaîne)

    Définit la chaîne de requête codée pour la liste, puis actualise la liste à l’aide du nouveau filtre.

    Cela préserve les paramètres groupby et orderby.

    Tableau 49. Paramètres
    Nom Type Description
    filtre Chaîne Chaîne de requête codée.
    Tableau 50. Renvoie
    Type Description
    nul

    GlideListV3 : setFirstRow(Numéro, première ligne)

    Définit la première ligne à afficher lorsque la liste est actualisée.

    Tableau 51. Paramètres
    Nom Type Description
    première ligne Numéro Numéro de ligne dans la liste.
    Tableau 52. Renvoie
    Type Description
    nul

    GlideListV3 : setFormTarget(cible de chaîne)

    Spécifie l’emplacement où afficher la réponse à partir du formulaire.

    Tableau 53. Paramètres
    Nom Type Description
    target Chaîne La valeur d’attribut form.target à utiliser.
    Tableau 54. Renvoie
    Type Description
    nul

    GlideListV3 : setGroupBy (chaîne groupBy)

    Définit les groupBy critères de la liste, pour un champ unique ou plusieurs champs.

    Pour un champ unique, utilisez field ou groupByField. Le préfixe groupBy est facultatif. Pour plusieurs champs, utilisez field1^field2^field3 ou groupByField1^groupByField2^groupByField3.

    Tableau 55. Paramètres
    Nom Type Description
    Chaîne groupBy Le groupe par critères pour la liste.
    Tableau 56. Renvoie
    Type Description
    nul

    GlideListV3 : setOrderBy(String orderBy)

    Définit les orderBy critères de la liste.

    Pour un seul champ d’ordre, utilisez orderBy champ ou orderByDescField. Pour plusieurs champs, utilisez orderByField1^orderByField2^orderByField3. orderBy spécifie l’ordre croissant et orderByDesc spécifie l’ordre décroissant. Ces chaînes de préfixe sont facultatives. Si cette option n’est pas spécifiée orderBy , elle est supposée.

    Tableau 57. Paramètres
    Nom Type Description
    orderBy Chaîne Champs Trier par simple ou multiple.
    Tableau 58. Renvoie
    Type Description
    nul

    GlideListV3 : setReferringUrl(URL de chaîne)

    Définit l’URL de référence du formulaire parent.

    Tableau 59. Paramètres
    Nom Type Description
    URL Chaîne URL du formulaire parent
    Tableau 60. Renvoie
    Type Description
    nul

    GlideListV3 : setRowsPerPage(Number numRows)

    Définissez le nombre de lignes à afficher sur une page.

    Tableau 61. Paramètres
    Nom Type Description
    numRows Numéro Nombre de lignes à afficher sur une page.
    Tableau 62. Renvoie
    Type Description
    nul

    GlideListV3 : showHideGroups(booléen showFlag)

    Affiche ou masque tous les groupes dans la liste et enregistre l’état réduit/étendu actuel des groupes selon les préférences de l’utilisateur.

    Tableau 63. Paramètres
    Nom Type Description
    showFlag Booléen Si la valeur est vraie, affiche les groupes dans la liste.
    Tableau 64. Renvoie
    Type Description
    nul

    GlideListV3 : showHideList(booléen showFlag)

    Affiche ou masque la liste et enregistre l’état réduit/développé actuel de la liste selon les préférences de l’utilisateur.

    Tableau 65. Paramètres
    Nom Type Description
    showFlag Booléen Si la valeur est vrai, affiche la liste.
    Tableau 66. Renvoie
    Type Description
    nul

    GlideListV3 : tri (champ de chaîne)

    Triez la liste par ordre croissant.

    Tableau 67. Paramètres
    Nom Type Description
    champ Chaîne Champ à utiliser pour trier la liste.
    Tableau 68. Renvoie
    Type Description
    nul

    GlideListV3 : sortDescending(champ de chaîne)

    Trie la liste par ordre décroissant.

    Tableau 69. Paramètres
    Nom Type Description
    champ Chaîne Champ utilisé pour trier la liste.
    Tableau 70. Renvoie
    Type Description
    nul

    GlideListV3 : toggleList()

    Active/désactive l’affichage de la liste entre réduit et développé, et enregistre l’état selon les préférences de l’utilisateur.

    Tableau 71. Paramètres
    Nom Type Description
    Aucun
    Tableau 72. Renvoie
    Type Description
    nul

    GlideListV3 : toggleListNoPref()

    Bascule l’affichage de la liste entre réduit et développé, mais n’enregistre pas l’état en tant que préférence utilisateur.

    Tableau 73. Paramètres
    Nom Type Description
    Aucun
    Tableau 74. Renvoie
    Type Description
    nul