Histórico da Página

...

Classe utilizada para alterar os registros que estão sendo enviados pela tela HTML;CustomRecord: Customizações de Registros. Ela pode ser utlizalida tanto no evento que retornam vários registros, com naqueles que é retornado apenas um.

Método

Descrição

Exemplo

getEntityKeyCharacter ( )

getEntityKeyInteger ( )

Retorno (CHARACTER,INTEGER): Chave do registro.

Retorna a chave do Registro na manipulação do Metadata (Alteração, Detalhe).

updateRecords ( pProg , pPiName )

Parâmetros:

pProg (HANDLE): Handle do programa UPC;
pPiName (CHARACTER): Nome da PI que será executada a cada registro dos dados. Ela deve receber como parâmetro um JsonObject que representa o registro, exemplo:
DEF INPUT PARAM oItem AS JsonObject NO-UNDO.

Retorno (LOGICAL): Indicativo se é possível alterar o registro.

Navega nos registros e executa uma PI interna da UPC para customização dos dados.

// Indica que dever ser executada a PI "pi_altera_registros" para 
// realizar a alteração nos registros
oCustRecords:updateRecords(THIS-PROCEDURE, "pi_altera_registros").

// PI que será executada para cada registro da Tabela
PROCEDURE pi_altera_registros:
DEF INPUT PARAM oItem AS JsonObject NO-UNDO.

// Atualiza a coluna "Cópia Usuário" com o valor da coluna "Usuário"
oItem:ADD("userCopy", oItem:getCharacter("userCode")).

// Altera o conteúdo da coluna "Nome", concatenado: "- Alterado"
oItem:SET("userName", oItem:getCharacter("userName") + " - Alterado").
END PROCEDURE.

f.CustomMessages

Responsável pela criação de Mensagens de Erro;

CustomMessages: Geração de MensagensClasse utilizada para criação de mensagens que erro que serão enviadas para a tela HTML.

Método

Descrição

Exemplo

createMessageError ( pMsgNumber , pMsgDescription , pMsgHelp )

Parâmetros:

pMsgNumber (INTEGER): Número da Mensagem;
pMsgDescription (CHARACTER): Descrição da Mensagem;
pMsgHelp (CHARACTER): Help da Mensagem.

Retorno (JsonObject): Mensagem no padrão TOTVS de Mensagem.

Cria uma mensagem do tipo ERROR para enviar ao FrontEnd.

// Valida se o campo "Caminho completo do executável GZIP" foi
// informado, se não foi, retorna uma mensagem de Erro

ASSIGN vValorAtual = oCustFields:getFieldValueCharacter("execGZIPProgram"). 

IF vValorAtual = "" OR vValorAtual = ? THEN

jsonIO = oCustMsgs:createMessageError(1, 
                                      "Caminho completo do executável GZIP OBRIGATÓRIO", 
"O campo 'Caminho completo do executável GZIP' deve ser informado, não pode ser branco !").

// Indica que não deve ser Salvo a Alteração do Registro
IF vValorAtual = "" OR vValorAtual = ? THEN
RETURN "NOK".

...

Árvore de páginas

Versões comparadas

Versão antiga 63

Nova versão 64

Chave

f.CustomMessages