Linha Logix

Páginas filhas
  • LGX - LFormMetaData

Versões comparadas

Versão antiga 8

changes.mady.by.user Cleane Hermann

Gravado em

comparado com

Nova versão 9

changes.mady.by.user Cleane Hermann

Gravado em

Chave

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

...

Expandir
titleBROWSE_ITEM_COUNT

Método GET: BROWSE_ITEM_COUNT

Quantidade de registros encontrados na operação 'Listar' do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"BROWSE_ITEM_COUNT") => INTEGER

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim

Retorno



Tipo

Descrição

INTEGERQuantidade de registros encontradosencontrados na operação 'Listar' do formulário.

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_browse_count = _ADVPL_get_property(l_form_reference,"BROWSE_ITEM_COUNT")

FOR l_ind = 1 TO l_browse_count 
   LET l_cod_item = _ADVPL_get_property(l_form_reference,"BROWSE_VALUE","item","cod_item",l_ind) 
   LET l_den_item = man10021_get_den_item(l_cod_item) 
   CALL _ADVPL_set_property(l_form_reference,"BROWSE_VALUE","item","den_item",l_ind,l_den_item)
END FOR



Expandir
titleBROWSE_VALUE

Método GET: BROWSE_VALUE

Valor de uma determinada linha e coluna da operação 'Listar' do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"BROWSE_VALUE", < l_table >, < l_column >, < l_line >, [ l_alias ]) => VALUE

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim
l_tableCHARNome da tabela da coluna do formulário da qual deseja-se retornar o valor,Sim
l_columnCHARNome da coluna do formulário da qual deseja-se retornar o valor.---Sim
l_lineCHARNúmero da linha do grid da operação 'Listar' da qual deseja-se retornar o valor.Sim
l_aliasCHARAlias da tabela com a coluna do formulário da qual deseja-se retornar o valor.Não

Retorno



TipoDescrição
VALUEValor de determinada linha e coluna da grid da operação 'Listar' do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_browse_count = _ADVPL_get_property(l_form_reference,"BROWSE_ITEM_COUNT")

FOR l_ind = 1 TO l_browse_count 
   LET l_cod_item = _ADVPL_get_property(l_form_reference,"BROWSE_VALUE","item","cod_item",l_ind) 
   LET l_den_item = man10021_get_den_item(l_cod_item) 
   CALL _ADVPL_set_property(l_form_reference,"BROWSE_VALUE","item","den_item",l_ind,l_den_item)
END FOR



Expandir
titleCOMPONENT_REFERENCE

Método GET: COMPONENT_REFERENCE

Referência do componente de um determinado campo do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"COMPONENT_REFERENCE", < l_table >, < l_column >, [ l_alias ]) => CHAR

Parâmetros



Nome

Tipo

Descrição

Obrigatório?

l_form_reference
CHAR
Referência do formulárioSim
l_tableCHARNome da tabela da coluna do formulário da qual deseja-se retornar o valor,Sim
l_columnCHARNome da coluna do formulário da qual deseja-se retornar o valor.---Sim
l_aliasCHARAlias da tabela com a coluna do formulário da qual deseja-se retornar o valor.Não

Retorno



Tipo

Descrição

CHARReferência do componente de um campo do formulário.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET l_component_reference = _ADVPL_get_property(l_form_reference,"COMPONENT_REFERENCE","item","cod_item")



Expandir
titleCONSTRUCT_REFERENCE

Método GET: CONSTRUCT_REFERENCE

Referência do filtro de consulta utilizado na operação de pesquisa do formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"CONSTRUCT_REFERENCE") => CHAR

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim

Retorno



TipoDescrição
CHARReferência do filtro de pesquisa (LConstruct) utilizado na operação padrão de pesquisa do formulário.

Exemplo



Bloco de código
languageruby
titlethemeExemplo SQLCODEConfluence
linenumberstrue
LET l_construct_reference = _ADVPL_get_property(l_form_reference,"CONSTRUCT_REFERENCE")



Expandir
titleDELETECURRENT_OPERATION

Método GET: CURRENT_OPERATION

Operação atual em execução no formulário.

Sintaxe



Bloco de código
_ADVPL_get_property(< l_form_reference >,"DELETE", < l_path >, [ l_headers ]CURRENT_OPERATION") => SMALLINTCHAR

Parâmetros



NomeTipoDescriçãoObrigatório?
Padrão
l_
path
form_reference
CHAR
Caminho do serviço REST para requisição.
Referência do formulárioSim
l_headers

Retorno



TipoDescrição
CHAR
Lista de cabeçalhos específicos da requisição.1Não

1 Por ser uma lista de valores, os cabeçalhos precisam ser informados no formato {{"Header1: Content1"},{"Header2: Content2"}}.

   Exemplo: {{"Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="}}.

Retorno

TipoDescriçãoSMALLINTVerdadeiro se a requisição foi efetuada com sucesso.
Nome da operação que está em execução, conforme cadastrado no programa "FRM1001 - Barra de Ferramentas".

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
#------------------------------------------------------------------------------#
FUNCTION LREST_getDELETE()
#------------------------------------------------------------------------------#
    DEFINE l_status SMALLINT

    LET l_statusLET l_current_operation = _ADVPL_get_property(ml_restform_reference,"DELETE","/posts/1")

    IF  l_status THEN
        CALL CONOUT("OK.:",CURRENT_OPERATION")



Expandir
titleEXECUTE_OPERATION

Método GET: EXECUTE_OPERATION 

Executa uma determinada operação do formulário, conforme cadastrada no programa "FRM1001 - Barra de Ferramentas".

Sintaxe



Bloco de código
_ADVPL_get_property(m< l_restform_reference >,"RESULTEXECUTE_OPERATION "))
 => SMALLINT

Parâmetros



NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulárioSim

Retorno



TipoDescrição
SMALLINTCaso a operação foi executado com sucesso retornará TRUE, caso contrário retornará FALSE.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
LET  ELSE
        CALL CONOUT("NOK:",l_where_clause = "item.cod_empresa = '01'"
LET l_status = _ADVPL_get_property(ml_restform_reference,"ERROREXECUTE_MESSAGE"))
    END IF
END FUNCTION

Observação

  • Para recuperar o resultado da requisição, utilize o método RESULT.
    • Para recuperar a mensagem de erro, no caso da requisição não ter sido executada, utilize o método ERROR_MESSAGE.
    OPERATION","find",l_where_clause)



    REFERENCE

    Referência do componente do grupo de componentes de determinado campo do formulário

    Executa uma determinada operação do formulário, conforme cadastrada no programa "FRM1001 - Barra de Ferramentas".

    Sintaxe



    Expandir
    titleRESULTGROUP_REFERENCE

    Método GET:

    EXECUTE

     GROUP_

    OPERATION 
    Âncora
    getResultgetResult
    Bloco de código
    _ADVPL_get_property(< l_form_reference >,"RESULTGROUP_REFERENCE") => CHAR

    Parâmetros



    NomeTipoDescriçãoObrigatório?
    l_form_reference
    CHAR
    		Referência do formulárioSim

    Retorno



    TipoDescrição
    CHARResultado obtido na execução da requisição RESTReferência do componente de um grupo de componentes do formulário.

    Exemplo



    Bloco de código
    languageruby
    themeConfluence
    linenumberstrue
    LET l_group_statusreference = _ADVPL_get_property(ml_restform_reference,"EXECUTE_OPERATIONGROUP_REFERENCE","item","/postscod_item")
    ExpandirtitleERROR_MESSAGE


    Métodos SET
    Métodos acessíveis através da função _ADVPL_set_property que permite alterar e manipular os valores do componente.
    ...
     Expandir
    titleHOST
    Método SET: HOST
    Define o endereço base para as requisições REST.
    Sintaxe


     Bloco de código
    CALL _ADVPL_set_property(< l_reference >,"HOST", < l_host >)
    Parâmetros


    NomeTipoDescriçãoObrigatório?Padrão
    l_hostCHAREndereço base das requisições REST.Sim
    Exemplo


     Bloco de código
    languageruby
    themeConfluence
    linenumberstrue
    #------------------------#
 FUNCTION LREST_setHOST()
#------------------------#
    CALL _ADVPL_set_property(m_rest_reference,"HOST","http://www.totvs.com.br")
 END FUNCTION


    Sintaxe
    ...
     Bloco de código
    LET m_form_reference = _ADVPL_create_component(NULL,"LFORMMETADATA")     
CALL _ADVPL_set_property(m_form_reference,"INIT_FORM",<form_name>,<4GLrecord1>,<4GLrecord2>,...,<4GLrecordN>) 
    Exemplo
    ...
     Bloco de código
    languageruby
    themeConfluence
    linenumberstrue
    DATABASE logix 

GLOBALS     
	DEFINE p_user        LIKE usuarios.cod_usuario     
	DEFINE p_cod_empresa LIKE empresa.cod_empresa 
END GLOBALS 

DEFINE mr_item           RECORD LIKE item.* 

DEFINE ma_item_man       ARRAY[100] OF RECORD LIKE item_man.* 

DEFINE m_form_reference  VARCHAR(10)

#-------------------# 
 FUNCTION man10021()
#-------------------#     
	# Verifica permissão para o usuário conforme módulo do programa.     

	IF  LOG_initApp("PADRAO") <> 0 THEN         
		RETURN     
	END IF     

	INITIALIZE mr_item.*, ma_item_man TO NULL     
	LET m_form_reference = _ADVPL_create_component(NULL,"LFORMMETADATA")     
	CALL _ADVPL_set_property(m_form_reference,"INIT_FORM","man10021",mr_item,ma_item_man) 
END FUNCTION
    ...