Árvore de páginas

CONTEÚDO

  1. Visão geral
  2. Construtores
  3. Métodos disponíveis

01. VISÃO GERAL

Classe utilitária para auxiliar na manipulação de objetos do metadados para o padrão do PO-UI.

02. CONSTRUTORES

ConstrutorDescrição
Metadata()Construtor padrão
Metadata(c-dialect AS char)Construtor com a inicialização com um dialeto específico
Metadata(h-tt-api AS handle)Construtor com a handle da temp-table relacionada a API
Metadata(h-tt-api AS HANDLE, c-except-fields AS CHAR)Construtor com a handle da temp-table relacionada a API e fields exceção (separado por virgula)

03. MÉTODOS DISPONÍVEIS

MétodoDescrição
initialize(c-dialect AS CHAR)

Inicializa a mensagem com um dialeto específico

Caso seja enviado em branco, será considerado o dialeto do usuário logado

loadFieldsFromTableBufferHandle(h-tt-api AS HANDLE, c-except-fields AS CHAR)Carrrega os campos de acordo com a handle da temp-table enviada e fields exceção (separado por virgula)
setTranslateLabels(translateLabels_ AS LOG)Habilita / desabilita a tradução das literais
setTranslateContext(translateContext_ AS CHAR)Seta um contexto padrão para a tradução
getFields()Retorna a classe Fields contendo os campos setados na classe
setTitle(title_ AS CHAR)Seta o título
setVersion(version_ AS INT)Seta a versão
keepFilters()Seta o valor TRUE para o campo "keepfilters"
notKeepFilters()Seta o valor FALSE para o campo "keepfilters"
concatFilters()Seta o valor TRUE para o campo "concatFilters"
notConcatFilters()Seta o valor FALSE para o campo "concatFilters"
autoRouter()Seta o valor TRUE para o campo "autoRouter"
notAutoRouter()Seta o valor FALSE para o campo "autoRouter"
setBreadcrumb(breadcrumb AS JSonObject)Seta os valores do breadcrumb
createListActionsDefault(route AS CHAR)Gera as rotas padrões da lista de ações conforme parâmetro
removeAction(cAction AS CHAR)Remove uma ação especifica conforme parâmetro
addAction(cAction AS CHAR, completeRoute AS CHAR)Adiciona uma ação especifica conforme parâmetro
addValidateField(property_ AS CHAR)Adiciona um campo para validação
addValidateFieldList(listProperty AS CHAR)Adiciona uma lista de campos para validação (deve ser enviado uma lista separados por ",")
addPageCustomAction(oPageCustomAction AS JSonObject)Adiciona uma pagina de customização padrão conforme objeto Json enviado
addPageCustomAction(cLabel AS CHAR, cAction AS CHAR, cURL AS CHAR, lSelectable AS LOG)Adiciona uma pagina de customização padrão conforme parâmetros enviados
addPageCustomAction(cLabel as CHAR, cAction as CHAR, cURL as CHAR, lSelectable as LOG, cIcon as CHAR):Adiciona uma pagina de customização padrão conforme parâmetros enviados
addTableCustomAction(oTableCustomAction AS JSonObject)Adiciona uma tabela de customização padrão conforme objeto Json enviado
addTableCustomAction(cLabel AS CHAR, cAction AS CHAR, cURL AS CHAR)Adiciona uma tabela de customização padrão conforme parâmetros enviados
addBreadcrumbItem(breadcrumbLabel AS CHAR, breadcrumbLink AS CHAR)Adiciona um item ao breadcrumb
generateBreadcrumbsAndTitleByEvent(event_ AS CHAR, entityName AS CHAR, route AS CHAR)

Gera o breadcrumb de acordo com o evento enviado como parâmetro

Tipos de eventos:

  • new
  • edit
  • detail
  • duplicate
  • copy
hideColumnsManager(hideColumnsManager_ AS LOG)Permite que o gerenciador de colunas, responsável pela definição de quais colunas serão exibidas, seja escondido.
addLiteral(property_ AS CHAR, label_ AS CHAR)Adiciona uma literal
addMessage(oMessage AS Message)Adiciona uma mensagem (no padrão da classe Message)
addMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR, errorType AS CHAR, helpUrl AS CHAR, detailMessage AS Message)Adiciona uma mensagem (de acordo com os parâmetro enviados)
addErrorMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR, helpUrl AS CHAR, detailMessage AS Message)Adiciona uma mensagem do tipo ERROR de acordo com os parâmetros enviados
addInformationMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR, helpUrl AS CHAR, detailMessage AS Message)Adiciona uma mensagem do tipo INFORMATION de acordo com os parâmetros enviados
addWarningMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR, helpUrl AS CHAR, detailMessage AS Message)Adiciona uma mensagem do tipo WARNING de acordo com os parâmetros enviados
addSucessMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR, helpUrl AS CHAR, detailMessage AS Message)Adiciona uma mensagem do tipo SUCCESS de acordo com os parâmetros enviados
setMessages(oMessages AS JsonArray)Seta uma lista de mensagens de acordo com a lista de Json enviado
getMessages()Retorna um JsonArray com as mensagens
translate(c-literal AS CHAR)Retorna um CHARACTER com a literal traduzida de acordo com o dialeto especificado
translate(c-literal AS CHAR, c-context AS CHAR)Retorna um CHARACTER com a literal traduzida de acordo com o dialeto e contexto especificados.
toJsonObject()Retorna um JsonObject com os campos setados nesta classe