Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

MétodoDescriçãoExemplo
setFieldLabel(pCodField, pCodLabel [, pGroupId]) 
Parameters:
- 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
 - Purpose: Altera o Label de um Atributo
setDisableField(pCodField [, pGroupId])
Parameters:
- pCodField (CHARACTER): Código do atributo
- pGroupId (CHARACTER): Agrupador onde o atributo está contido 
Retorno (LOGICAL): Indicativo se foi possível desabilitar o atributo
 - Purpose: Desabilita um Atributo
setEnableField(pCodField [, pGroupId])
Parameters:
- pCodField (CHARACTER): Código do atributo
- pGroupId (CHARACTER): Agrupador onde o atributo está contido 
Retorno (LOGICAL): Indicativo se foi possível habilitar o atributo
 - Purpose: Habilita um Atributo
setHideField(pCodField [, pGroupId])
Parameters:
- pCodField (CHARACTER): Código do atributo
- pGroupId (CHARACTER): Agrupador onde o atributo está contido 
Retorno (LOGICAL): Indicativo se foi possível esconder o atributo
 - Purpose: Esconde um Atributo
setShowField(pCodField [, pGroupId])
Parameters:
- pCodField (CHARACTER): Código do atributo
- pGroupId (CHARACTER): Agrupador onde o atributo está contido 
Retorno (LOGICAL): Indicativo se foi possível apresentar o atributo
 - Purpose: Mostra um Atributo
setFieldProperty(pCodField, pCodProperty, pCodValue [, pGroupId])
Parameters:
- 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
 - Purpose: Altera uma propriedade de um Atributo
getFieldPropertyCharacter(pCodField, pCodProperty [, pGroupId])
getFieldPropertyInteger(pCodField, pCodProperty [, pGroupId])
getFieldPropertyDecimal(pCodField, pCodProperty [, pGroupId])
getFieldPropertyLogical(pCodField, pCodProperty [, pGroupId])
Parameters:
- 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
 - Purpose: Retorna o valor de uma propriedade de um Atributo
getFields([pGroupId])
Parameters:
- pGroupId (CHARACTER): Agrupador onde o atributo está contido
Retorno (JsonArray): Lista de Atributos
 - Purpose: Retorna um JsonArray que representa a lista de Atributos
getField(pCodField [, pGroupId])
Parameters:
- pCodField (CHARACTER): Código do atributo
- pGroupId (CHARACTER): Agrupador onde o atributo está contido 
Retorno (JsonObject): Um atributo
 - Purpose: Retorna um JsonObject que representa um Atributo
addField(pCodField, pCodLabel, pCodType [, pPosition] [, pGroupId])
Parameters:
- 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
 - Purpose: Incluir um novo Atributo
changeFieldOrder(pCodField [, pPosition] [, pGroupId]) 
Parameters:
- 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
 - Purpose: Altera a Ordem de um Atributo
setFieldValidate(pCodField, pCodProg [, pGroupId]) 
setFieldValidateCustom(pCodField, pEndpoint [, pGroupId])
Parameters:
- 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
 - Purpose: Incluir a propriedade 'validate' no atributo (monitora a alterado do campo - evento validateField)
addValidateFields(pCodField)
Parameters:
- pCodField (CHARACTER): Código do atributo
Retorno (LOGICAL): Lógico indicativo se foi possível incluir o atributo
Nota: Utilizar este método para tela que implementam o componente DynamicForm
 - Purpose: Inclui um atributo no ValidateFields do Formulário (evento validateForm) 
isChangedField(pCodField)
Parameters:
- pCodField (CHARACTER): Código do atributo
Retorno (LOGICAL): Lógico indicativo se o atributo teve seu valor alterado
 - Purpose: Verifica se um Atributo foi alterado (eventos ValidateForm e ValidateField)
getReturnRoot()
Retorno (JsonObject): Root de retorno
 - Purpose: Retorno um JsonOject que representa o Root de retorno (eventos ValidateForm e ValidateField)
getFieldValueCharacter(pCodField)
getFieldValueInteger(pCodField)
getFieldValueDecimal(pCodField)
getFieldValueLogical(pCodField)
getFieldValueDate(pCodField)
getFieldValueJsonObject(pCodField)
getFieldValueJsonArray(pCodField)
Parameters:
- pCodField (CHARACTER): Código do atributo
Retorno (CHARACTER,INTEGER,DECIMAL,LOGICAL,DATE,JsonObject,JsonArray): Valor do atributo
 - Purpose: Retorna o valor de um atributo

setFieldValue(pCodField, pCodValue)
Parameters:
- 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() - Purpose: Retorno um JsonOject que representa os Valores do registro ou retorno(eventos ValidateForm e ValidateField)
Retorno (JsonObject): Valores do registro

 - Purpose: Altera o valor de um Atributo

...