Linha Datasul

Á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 no retorno das mensagens no padrão do PO-UI.

02. CONSTRUTORES

ConstrutorDescrição
Message()Construtor padrão
Message(c-dialect AS CHAR)Construtor com a inicialização com um dialeto específico
Message(i-cod-msg-ems AS INT, errorType AS CHAR, msgParameters AS CHAR, helpUrl AS CHAR)

Construtor com parâmetros da mensagem

  • i-cod-msg-ems: Código do ems da mensagem;
  • errorType: Tipo da mensagem (error, information, warning ou success);
  • msgParameters: Parâmetros da mensagem enviados ao utilitário utp/ut-msgs.p;
  • helpUrl: Texto de ajuda da mensagem.

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

errorMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR)

Seta uma mensagem do tipo ERROR com os parâmetros enviados

  • code_: Código do erro;
  • message_: Texto com a descrição da mensagem;
  • detailedMessage: Texto com o detalhamento da mensagem,
informationMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR)

Seta uma mensagem do tipo INFORMATION com os parâmetros enviados

  • code_: Código do erro;
  • message_: Texto com a descrição da mensagem;
  • detailedMessage: Texto com o detalhamento da mensagem,
warningMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR)

Seta uma mensagem do tipo WARNING com os parâmetros enviados

  • code_: Código do erro;
  • message_: Texto com a descrição da mensagem;
  • detailedMessage: Texto com o detalhamento da mensagem,
successMessage(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR)

Seta uma mensagem do tipo SUCCESS com os parâmetros enviados

  • code_: Código do erro;
  • message_: Texto com a descrição da mensagem;
  • detailedMessage: Texto com o detalhamento da mensagem,
setMessageData(code_ AS CHAR, message_ AS CHAR, detailedMessage AS CHAR, errorType AS CHAR, helpUrl AS CHAR, detailMessage AS Message)

Seta os dados da mensagem

  • code_: Código do erro;
  • message_: Texto com a descrição da mensagem;
  • detailedMessage: Texto com o detalhamento da mensagem,
  • errorType: Tipo da mensagem (error, information, warning ou success);
  • helpUrl: Texto de ajuda da mensagem;
  • detailMessage: Detalhes da mensagem do tipo "Message".
setCode(code_ AS CHAR)Seta o código da mensagem.
setMessage(message_ AS CHAR)Seta um texto com a descrição.
setDetailedMessage(detailedMessage AS CHAR)

Seta um texto com o detalhes.

setHelpUrl(helpUrl AS CHAR)Seta o texto da ajuda,
setErrorType(errorType AS CHAR)

Seta o tipo da mensagem (error, information, warning ou success).

addDetail(oMessage_ AS Message)Adiciona os detalhes da mensagem.
translate(c-literal AS CHAR)Retorna um CHARACTER com a literal traduzida de acordo com o dialeto especificado.
toJsonObject()Retorna um objeto Json com os dados da mensagem.