Histórico da Página

setAction ( pCodAction , pCodValue )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação;
• pCodValue: Valor da Ação, usar uma das opções:
  • pCodURL (CHARACTER): Valor da URL a ser executada pela Ação;
  • pCodValue (LOGICAL): Valor da Ação.

Retorno (LOGICAL): Indicativo se foi possível incluir/alterar a Ação.

// Retira a Ação Padrão de "Excluir" da Tabela    

oCustActions:setAction("remove",
                       FALSE).

getActionCharacter ( pCodAction )

getActionLogical ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação.

Retorno (CHARACTER,LOGICAL): Valor da Ação.

// Faz a Ação Padrão de Visualizar abrir a tela de Edição

oCustActions:setAction("detail",
                       oCustActions:getActionCharacter("edit")).

removeAction ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Ação.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

// Retira a Ação Padrão de "Cópia" da Tabela

oCustActions:removeAction("duplicate").

getActions ( )

Retorno (JsonObject): Ações padrões.

setPageCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor.

Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade.

// Inclui o icone de Refresh na Ação Customizada "Atz Dados" da Pagina

oCustActions:setPageCustomActionProperty("Atz Dados",
                                         "icon",
                                         "po-icon po-icon po-icon-refresh").

getPageCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getPageCustomActionPropertyInteger ( pIdAction , pCodProperty )

getPageCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getPageCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

getPageCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (JsonObject): Uma Ação Customizada de Página.

// Altera o Endereço da primeira Ação Customizada da Pagina

oAction = oCustActions:getPageCustomAction(1).

IF oAction <> ? THEN

oAction:set("action", 
            "http://newserver:8080/customer").

addPageCustomAction ( pNumType , pCodLabel , pCodAddress [ , pCodIcon ] )

Parâmetros:

• pNumType: Tipo da Ação, usar uma das opções:
  • CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd;
  • CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL).
• pCodLabel (CHARACTER): Label da Ação;
• pCodAddress (CHARACTER): Endereço da Ação que será executada;
• pCodIcon (CHARACTER): Ícone da Ação.

Retorno (JsonObject): Ação Customizada de Página Incluída.

// Inclui uma nova Ação Customizada no Pagina chamada "Atz Dados" que chama
// uma EndPoint
oCustActions:addPageCustomAction(CustomActions:TYPE_ENDPOINT, 
                                 "Atz Dados",
                                 "http://server01:3000/atzDados").

// Inclui uma nova Ação Customizada no Pagina chamada "Google" que chama uma
// Rota
oCustActions:addPageCustomAction(CustomActions:TYPE_ROUTE,
                                 "Google",
                                 "http://www.google.com",
                                 "po-icon po-icon-device-desktop").

removePageCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

// Elimina a Ação Customizada chamada "Doctos" da Pagina

oCustActions:removePageCustomAction("Doctos").

getPageCustomActions ( )

Retorno (JsonArray): Ações Customizadas de Página.

setTableCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor.

Retorno (LOGICAL): Indicativo se foi possível alterar a propriedade.

getTableCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getTableCustomActionPropertyInteger ( pIdAction , pCodProperty )

getTableCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getTableCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.
• pCodProperty: Propriedade.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL): Valor da Propriedade.

getTableCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (JsonObject): Uma Ação Customizada de Tabela.

addTableCustomAction ( pNumType , pCodLabel , pCodAddress [ , pCodIcon ] [ , pConcatKeys ] )

Parâmetros:

• pNumType: Tipo da Ação, usar uma das opções:
  • CustomActions:TYPE_ENDPOINT - para chamada ao BackEnd;
  • CustomActions:TYPE_ROUTE - para chamada de uma Rota (URL).
• pCodLabel (CHARACTER): Label da Ação;
• pCodAddress (CHARACTER): Endereço da Ação que será executada;
• pCodIcon (CHARACTER): Ícone da Ação;
• pConcatKeys (LOGICAL): Indica se deve ser acrescentada a propriedade "concatKeys" na Ação.

Retorno (JsonObject): Ação Customizada de Tabela Incluída.

// Inclui uma nova Ação Customizada no Tabela chamada "Bloqueia" que chama
// uma EndPoint
oCustActions:addTableCustomAction(CustomActions:TYPE_ENDPOINT,
                                  "Bloqueia",
                                  "http://server01:3000/block",
                                  "po-icon po-icon po-icon-refresh").

// Inclui uma nova Ação Customizada no Tabela chamada "Det Adicional" que
// chama uma Rota
oCustActions:addTableCustomAction(CustomActions:TYPE_ROUTE,
                                  "Det Adicional",
                                  "http://newserver:8080/dts/customer/detail").

removeTableCustomAction ( pIdAction )

Parâmetros:

• pIdAction: Identificador da Ação, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Ação;
  • pNumIndex (INTEGER): Posição da Ação dentro da Lista de Ações.

Retorno (LOGICAL): Indicativo se foi possível remover a Ação.

// Elimina a Ação Customizada chamada "Relacto" da Pagina

oCustActions:removeTableCustomAction("Relacto").

getTableCustomActions ( )

Retorno (JsonArray): Ações Customizadas de Tabela.

getServerAddress ( pIsExt )

Parâmetros:

• pIsExt (LOGICAL): Indica se deve ser considerado o Endereço Exerno (Valor: TRUE) ou Interno (Valor:FALSE). Se for solicitado o Externo e ele não existir, será devolvido o interno.

Retorno (CHARACTER): Endereço no formato: http://HOST:PORT.

getEntityKeyCharacter ( )

getEntityKeyInteger ( )

Retorno (CHARACTER,INTEGER): Chave do registro.

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.