Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 20

changes.mady.by.user Adriano De Avila

Gravado em

comparado com

Nova versão 21

changes.mady.by.user Adriano De Avila

Gravado em

Chave

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

...

---------------------
Construção das Classe
---------------------

CONSTRUCTOR CustomXXXX ( pOrigin, pObjParam )Construtor da Classe Classe

Parâmetros:-

  • pOrigin: Local/Origem onde está sendo utilizado a Classe (usar a classe CustomOrig, ex: CustomOrig:ORIG_METADATA)

...

  • ;

...

  • pObjParam (JsonObject): JsonObeject de Parâmetros recebido pela

...

  • UPC.

Retorno (CustomXXX): Instancia da Classe

...

  • CustomOrig:ORIG_METADATA - Método de manipulação do Metadata;
  • CustomOrig:ORIG_VLD_FORM - Método de manipulação do validateForm;
  • CustomOrig:ORIG_VLD_FIELD - Método de manipulação do validateField;
  • CustomOrig:ORIG_GET_RECORD - Método de manipulação na busca de um registro;
  • CustomOrig:ORIG_GET_ALL - Método de manipulação na busca de vários registros;
  • CustomOrig:ORIG_CREATE_RECORD - Método de criação de um registro;
  • CustomOrig:ORIG_UPDATE_RECORD - Método de alteração de um registro;
  • CustomOrig:ORIG_DELETE_RECORD - Método de eliminação de um registro.

------------------
CLASSE: CustomPage: Customizações da Página
------------------

MétodoDescriçãoExemplo

setPageTitle ( pCodTitle )

Parâmetros:

  • pCodTitle (CHARACTER): Novo Titulo da Page.

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

Altera o Titulo da Page.

getPageTitle ( )

Retorno (CHARACTER): Título da Página.

Retorna o Titulo da Page. 

setPageProperty ( pCodProperty , pCodValue )

Parâmetros:

  • pCodProperty (CHARACTER): Propriedade que deve ser alterada;
  • pCodValue (CHARACTER,INTEGER,DECIMAL,LOGICAL): Novo valor.

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

Altera uma propriedade da Tela.

getPagePropertyCharacter ( pCodProperty )

getPagePropertyInteger ( pCodProperty )

getPagePropertyDecimal ( pCodProperty )

getPagePropertyLogical ( pCodProperty )

Parâmetros:

  • pCodProperty (CHARACTER): Propriedade.

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

Retorna o valor de uma propriedade da Tela.

...

MétodoDescriçãoExemplo

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.

Altera o Label de um Atributo.

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.

Desabilita um 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.

Habilita um 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.

Esconde um 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.

Mostra um 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.

Altera uma propriedade de um Atributo.

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.

Retorna o valor de uma propriedade de um Atributo.

getFields ( [ pGroupId ] )

Parâmetros:

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

Retorno (JsonArray): Lista de Atributos.

Retorna um JsonArray que representa a 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

Retorna um JsonObject que representa 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

Incluir um novo Atributo.

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

Altera a Ordem de um Atributo.

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

Incluir a propriedade 'validate' no atributo (monitora a alterado do campo - evento validateField).

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

Verifica se um Atributo foi alterado (eventos ValidateForm e ValidateField).

getReturnRoot ( )

Retorno (JsonObject): Root de retorno

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 )

Parâmetros:

  • pCodField (CHARACTER): Código do atributo

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

Retorna o valor de um 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

Altera o valor de um Atributo.

getFieldValues ( )

Retorno (JsonObject): Valores do registro

Retorno um JsonOject que representa os Valores do registro ou retorno(eventos ValidateForm e ValidateField).

...