Histórico da Página

setFieldLabel ( pCodField , pCodLabel [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pCodLabel (CHARACTER): Novo label do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (LOGICAL): Indicativo se foi possível alterar o Label.

setDisableField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (LOGICAL): Indicativo se foi possível desabilitar o atributo.

setEnableField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (LOGICAL): Indicativo se foi possível habilitar o atributo.

setHideField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (LOGICAL): Indicativo se foi possível esconder o atributo.

setShowField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (LOGICAL): Indicativo se foi possível apresentar o atributo.

setFieldProperty ( pCodField , pCodProperty , pCodValue [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pCodProperty (CHARACTER): Propriedade que deve ser alterada;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

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

getFieldPropertyCharacter ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyInteger ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyDecimal ( pCodField , pCodProperty [ , pGroupId ] )

getFieldPropertyLogical ( pCodField , pCodProperty [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pCodProperty (CHARACTER): Propriedade;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

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

getFields ( [ pGroupId ] )

Parâmetros:

• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (JsonArray): Lista de Atributos.

getField ( pCodField [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (JsonObject): Um atributo.

addField ( pCodField , pCodLabel , pCodType [ , pPosition ] [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do Atributo;
• pCodLabel (CHARACTER): Label do Atributo;
• pCodType (CHARACTER): Tipo do Atributo (usar a classe FieldType, ex: FieldType:STRING);
• pPosition: Posição onde o campo irá ficar no Formulário, usar uma da opções:
  • pIsFirst (LOGICAL): O Atributo será o Primeiro do Formulário (valor: YES) ou o Útimo (valor: NO);
  • pReferenceField (CHARACTER): Código de um Atributo já existente, onde o atributo ficará DEPOIS dele;
  • Se não informado valor, o atributo será o Último do Formulário.
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (JsonObject): Atributo Incluído.

changeFieldOrder ( pCodField [ , pPosition ] [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do Atributo;
• pPosition: Posição onde o campo irá ficar no Formulário, usar uma da opções:
  • pIsFirst (LOGICAL): O Atributo será o Primeiro do Formulário (valor: YES) ou o Útimo (valor: NO);
  • pReferenceField (CHARACTER): Código de um Atributo já existente, onde o atributo ficará DEPOIS dele;
  • Se não informado valor, o atributo será o Último do Formulário.
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

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

setFieldValidate ( pCodField , pCodProg [ , pGroupId ] )

setFieldValidateCustom ( pCodField , pEndpoint [ , pGroupId ] )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pCodProg (CHARACTER): API-REST de Produto (deve ser enviado o terceiro parâmetro recebido pela UPC). Quando o atributo for alterado, será executado o Endpoint 'validateField' da API-REST do Produto;
• pEndpoint (CHARACTER): Endpoint (método POST) que será executado quando o atributo for alterado. O caminho do Endpoint pode ser relativo (API-REST dentro do datasul) ou completo;
• pGroupId (CHARACTER): Agrupador onde o atributo está contido.

Retorno (LOGICAL): Indicativo se foi possível incluir a propriedade no atributo.

addValidateFields ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;

Retorno (LOGICAL): Lógico indicativo se foi possível incluir o atributo.

Inclui um atributo no ValidateFields do Formulário (evento validateForm).

Nota: Utilizar este método para tela que implementam o componente DynamicForm

isChangedField ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;

Retorno (LOGICAL): Lógico indicativo se o atributo teve seu valor alterado.

getReturnRoot ( )

Retorno (JsonObject): Root de retorno.

getFieldValueCharacter ( pCodField )

getFieldValueInteger ( pCodField )

getFieldValueDecimal ( pCodField )

getFieldValueLogical ( pCodField )

getFieldValueDate ( pCodField )

getFieldValueJsonObject ( pCodField )

getFieldValueJsonArray ( pCodField )

Parâmetros:

• pCodField (CHARACTER): Código do atributo.

Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE,JsonObject,JsonArray): Valor do atributo.

setFieldValue ( pCodField , pCodValue )

Parâmetros:

• pCodField (CHARACTER): Código do atributo;
• pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE): Novo valor.

Retorno (LOGICAL): Indicativo se foi possível alterar o atributo.

getFieldValues ( )

Retorno (JsonObject): Valores do registro.

setAction ( pCodAction , pCodValue )

Parâmetros:

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

Retorno (LOGICAL): Indicativo se foi possível incluir/alterar a Action.

getActionCharacter ( pCodAction )

getActionLogical ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Action.

Retorno (CHARACTER,LOGICAL): Valor da Action.

removeAction ( pCodAction )

Parâmetros:

• pCodAction (CHARACTER): Código da Action.

Retorno (LOGICAL): Indicativo se foi possível remover a Action.

getActions ( )

Retorno (JsonObject): Actions padrões.

setPageCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

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

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

getPageCustomActionPropertyCharacter ( pIdAction , pCodProperty )

getPageCustomActionPropertyInteger ( pIdAction , pCodProperty )

getPageCustomActionPropertyDecimal ( pIdAction , pCodProperty )

getPageCustomActionPropertyLogical ( pIdAction , pCodProperty )

Parâmetros:

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

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

getPageCustomAction ( pIdAction )

Parâmetros:

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

Retorno (JsonObject): Uma Action Customizada de Página.

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

Parâmetros:

• pNumType: Tipo da Action, 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 Action;
• pCodAddress (CHARACTER): Endereço da Action que será executada;
• pCodIcon (CHARACTER): Ícone da Action.

Retorno (JsonObject): Action Customizada de Página Incluída.

removePageCustomAction ( pIdAction )

Parâmetros:

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

Retorno (LOGICAL): Indicativo se foi possível remover a Action.

getPageCustomActions ( )

Retorno (JsonArray): Actions Customizadas de Página.

setTableCustomActionProperty ( pIdAction , pCodProperty , pCodValue )

Parâmetros:

• pIdAction: Identificador da Action, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Action;
  • pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions.
• 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 Action, usar uma das opções:
  • pCodLabel (CHARACTER): Label da Action;
  • pNumIndex (INTEGER): Posição da Action dentro da Lista de Actions.
• pCodProperty: Propriedade.

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

getTableCustomAction ( pIdAction )

Parâmetros:

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

Retorno (JsonObject): Uma Action Customizada de Tabela.

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

Parâmetros:

• pNumType: Tipo da Action, 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 Action;
• pCodAddress (CHARACTER): Endereço da Action que será executada;
• pCodIcon (CHARACTER): Ícone da Action;
• pConcatKeys (LOGICAL): Indica se deve ser acrescentada a propriedade "concatKeys" na Action.

Retorno (JsonObject): Action Customizada de Tabela Incluída.

removeTableCustomAction ( pIdAction )

Parâmetros:

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

Retorno (LOGICAL): Indicativo se foi posssível remover a Action.

getTableCustomActions ( )

Retorno (JsonArray): Actions 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.

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

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

Nota: A PI deve receber como parâmetro um JsonObject que representa o registro, ex:
      DEF INPUT PARAM oItem AS JsonObject NO-UNDO.