GlideListV3 (g_list) - Cliente

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 7 min. de leitura

    • Use o GlideListV3 para manipular listas.

    Você acessa os métodos GlideListV3 usando o objeto global g_list. Esses métodos são usados em menus de contexto de IU e ações de IU. O objeto g_list não está disponível para listas relacionadas na ação de IU do link do formulário.

    Nota:

    Esta API não é mais compatível. Considere usar a API GlideList2().

    GlideListV3 - addFilter(cadeia de caracteres "filtro")

    Adiciona um único termo ao filtro de consulta da lista.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    filtros Cadeia de caracteres Condição da cadeia de caracteres de consulta a ser adicionada.
    Tabela 2. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - get(cadeia de caracteres listId)

    Retorna o objeto GlideList para a lista especificada.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    listId Cadeia de caracteres O nome da lista.
    Tabela 4. Retorna
    Tipo Descrição
    Objeto O objeto GlideList para a lista especificada ou nulo se não for encontrado.

    GlideListV3 - get(Object DomElement)

    Retorna o objeto GlideList para o elemento DOM especificado.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    ElementoDomínio Objeto O ID do elemento DOM para o qual você deseja o objeto GlideList.
    Tabela 6. Retorna
    Tipo Descrição
    Objeto O objeto GlideList para o elemento DOM especificado. Retornará nulo se o elemento DOM não for encontrado.

    GlideListV3 – getChecked()

    Retorna uma lista separada por vírgulas de sys_ids para itens marcados na lista. Não retorna itens que não podem ser executados.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres Lista separada por vírgulas dos sys_ids dos itens marcados na lista. Não retorna itens que não podem ser executados.

    GlideListV3 – getFixedQuery()

    Retorna a consulta sysparm_fixed.

    A consulta fixa é a parte da consulta que não pode ser removida da trilha (ou seja, é fixa para o usuário). É especificado pela inclusão de um parâmetro sysparm_fixed_query para o módulo da aplicação.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres A cadeia de caracteres de consulta fixa para a lista.

    GlideListV3 – getFormTarget()

    Retorna o atributo de destino do formulário.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Cadeia de caracteres O atributo de destino do formulário.

    GlideListV3 – getGroupBy()

    Retorna o campo ou a lista separada por vírgulas de campos que são usados para agrupar a lista.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Cadeia de caracteres O campo ou a lista separada por vírgulas de campos usados para agrupar a lista.

    GlideListV3 – getListName()

    Retorna o nome da lista, que geralmente é o nome da tabela.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 16. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da lista.

    GlideListV3 – getOrderBy()

    Retorna o primeiro campo usado para ordenar a lista.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 18. Retorna
    Tipo Descrição
    Cadeia de caracteres O campo usado para ordenar a lista ou uma cadeia de caracteres vazia se a lista não estiver classificada.

    GlideListV3 – getParentTable()

    Retorna o nome da tabela primária (a tabela associada ao formulário).

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 20. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da tabela primária.

    GlideListV3 - getQuery(opções de objeto)

    Retorna a cadeia de caracteres de consulta codificada da lista.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    opções Objeto As opções podem ser uma ou mais das seguintes.
    • orderby — Inclui ORDERBY na consulta
    • groupby — Inclui GROUPBY na consulta
    • fixed - inclui sysparm_fixed_query na consulta
    • all - inclui todas as opções na consulta
    Tabela 22. Retorna
    Tipo Descrição
    Cadeia de caracteres Cadeia de caracteres de consulta codificada para a lista.

    GlideListV3 – getReferringUrl()

    Retorna o URL de referência.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 24. Retorna
    Tipo Descrição
    Cadeia de caracteres Retorna o URL do formulário primário ou '*' se não houver nenhum formulário primário.

    GlideListV3 – getRelated()

    Retorna o campo de lista relacionada que associa a lista relacionada ao formulário primário.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 26. Retorna
    Tipo Descrição
    Cadeia de caracteres Campo que conecta a lista ao formulário primário.

    GlideListV3 – getRelatedListType()

    Retorna o tipo de lista relacionada.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 28. Retorna
    Tipo Descrição
    Cadeia de caracteres O tipo de tabela de relacionamento.

    GlideListV3 – getRelationshipId()

    Retorna o ID do registro de relacionamento, se for uma lista relacionada de REL do tipo.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 30. Retorna
    Tipo Descrição
    Cadeia de caracteres O sys_id do registro de relacionamento.

    GlideListV3 – getRowCount()

    Retorna o número de linhas retornadas pela consulta.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 32. Retorna
    Tipo Descrição
    Número O número de linhas retornadas pela consulta.

    GlideListV3 – getRowsPerPage()

    Retorna o número de linhas a serem exibidas em uma página.

    Tabela 33. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 34. Retorna
    Tipo Descrição
    Número O número de linhas a serem exibidas em uma página.

    GlideListV3 – getTableName()

    Retorna o nome da tabela da lista.

    Tabela 35. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 36. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da tabela da lista.

    GlideListV3 – getTitle()

    Retorna o título da lista.

    Tabela 37. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 38. Retorna
    Tipo Descrição
    Cadeia de caracteres O título da lista.

    GlideListV3 – getView()

    Retorna a exibição usada para exibir a lista.

    Tabela 39. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 40. Retorna
    Tipo Descrição
    Cadeia de caracteres O nome da exibição

    GlideListV3 – isUserList()

    Retorna verdadeiro se a lista tiver sido personalizada pelo usuário.

    Tabela 41. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 42. Retorna
    Tipo Descrição
    Booliano Verdadeiro se o layout da lista tiver sido alterado.

    GlideListV3 - refresh(Number firstRow, Object additionalParams)

    Atualiza a lista. A parte orderBy do filtro da lista é ignorada para que a ordem natural da lista seja usada.

    Tabela 43. Parâmetros
    Nome Tipo Descrição
    primeiraLinha Número (Opcional) A primeira linha a ser exibida na lista. Se não for especificado, a primeira linha atual da lista será usada.
    additionalParams Objeto (Opcional) Pares de nome-valor que são enviados com a solicitação de atualização da lista.
    Tabela 44. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - refreshWithOrderBy(Number firstRow, Object additionalParams)

    Atualiza a lista usando os campos orderBy.

    Tabela 45. Parâmetros
    Nome Tipo Descrição
    primeiraLinha Número (Opcional) A primeira linha a ser exibida na lista. Se não for especificado, a primeira linha atual da lista será usada.
    additionalParams Objeto (Opcional) Pares de nome-valor que são enviados com a solicitação de atualização da lista.
    Tabela 46. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setFilter(cadeia de caracteres "filtro", booliano saveOrderBy, booliano saveGroupBy)

    Define a cadeia de caracteres de consulta codificada para a lista ignorando as partes orderBy e groupBy da cadeia de caracteres de consulta.

    Tabela 47. Parâmetros
    Nome Tipo Descrição
    filtros Cadeia de caracteres Uma cadeia de caracteres de consulta codificada.
    salvarOrdemBy Booliano O padrão é falso. Quando verdadeiro, usa a parte orderBy da consulta.
    salvarGrupoPor Booliano O padrão é falso. Quando verdadeiro, usa a parte groupBy da consulta.
    Tabela 48. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setFilterAndRefresh(Filtro de cadeia de caracteres)

    Define a cadeia de caracteres de consulta codificada da lista e atualiza a lista usando o novo filtro.

    Isso preserva os parâmetros groupby e orderby.

    Tabela 49. Parâmetros
    Nome Tipo Descrição
    filtros Cadeia de caracteres Cadeia de caracteres de consulta codificada.
    Tabela 50. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setFirstRow(Number firstRow)

    Define a primeira linha a ser exibida quando a lista é atualizada.

    Tabela 51. Parâmetros
    Nome Tipo Descrição
    primeiraLinha Número O número da linha na lista.
    Tabela 52. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setFormTarget(cadeia de caracteres "target")

    Especifica onde exibir a resposta do formulário.

    Tabela 53. Parâmetros
    Nome Tipo Descrição
    destino Cadeia de caracteres O valor do atributo form.target a ser usado.
    Tabela 54. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setGroupBy(cadeia de caracteres groupBy)

    Define os critérios groupBy para a lista, para um único campo ou vários campos.

    Para um único campo, use field ou groupByField. O prefixo groupBy é opcional. Para vários campos, use field1 ^ field2^field3 ou groupByField1^groupByField2^groupByField3.

    Tabela 55. Parâmetros
    Nome Tipo Descrição
    Cadeia de caracteres groupBy O grupo por critérios para a lista.
    Tabela 56. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setOrderBy(cadeia de caracteres orderBy)

    Define os critérios orderBy para a lista.

    Para uma única ordem por campo, use orderBy campo ou orderByDescField. Para vários campos, use orderByField1^orderByField2^orderByField3. orderBy especifica a ordem crescente e orderByDesc especifica decrescente. Essas cadeias de caracteres de prefixo são opcionais. Se não especificado orderBy, será presumido.

    Tabela 57. Parâmetros
    Nome Tipo Descrição
    orderBy Cadeia de caracteres Ordenação única ou múltipla por campos.
    Tabela 58. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setReferringUrl(cadeia de caracteres url)

    Define a URL de referência do formulário primário.

    Tabela 59. Parâmetros
    Nome Tipo Descrição
    url Cadeia de caracteres A URL do formulário primário
    Tabela 60. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - setRowsPerPage(Number numRows)

    Defina o número de linhas a serem exibidas em uma página.

    Tabela 61. Parâmetros
    Nome Tipo Descrição
    numRows Número O número de linhas a serem exibidas em uma página.
    Tabela 62. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - showHideGroups(booliano showFlag)

    Exibe ou oculta todos os grupos na lista e salva o estado atual recolhido/expandido dos grupos como uma preferência do usuário.

    Tabela 63. Parâmetros
    Nome Tipo Descrição
    sinalizador Booliano Quando verdadeiro, exibe os grupos na lista.
    Tabela 64. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - showHideList(booliano showFlag)

    Exibe ou oculta a lista e salva o estado recolhido/expandido atual da lista como uma preferência do usuário.

    Tabela 65. Parâmetros
    Nome Tipo Descrição
    sinalizador Booliano Quando verdadeiro, exibe a lista.
    Tabela 66. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - classificado(campo Cadeia de caracteres)

    Classifique a lista em ordem crescente.

    Tabela 67. Parâmetros
    Nome Tipo Descrição
    Assunto: Cadeia de caracteres O campo a ser usado para classificar a lista.
    Tabela 68. Retorna
    Tipo Descrição
    vazio

    GlideListV3 - listDescending(cadeia de caracteres no campo)

    Classifica a lista em ordem decrescente.

    Tabela 69. Parâmetros
    Nome Tipo Descrição
    Assunto: Cadeia de caracteres O campo usado para classificar a lista.
    Tabela 70. Retorna
    Tipo Descrição
    vazio

    GlideListV3 – toggleList()

    Alterna a exibição da lista entre recolhida e expandida e salva o estado como uma preferência do usuário.

    Tabela 71. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 72. Retorna
    Tipo Descrição
    vazio

    GlideListV3 – alternarListNoPref()

    Alterna a exibição da lista entre recolhida e expandida, mas não salva o estado como uma preferência do usuário.

    Tabela 73. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 74. Retorna
    Tipo Descrição
    vazio