Conceito

Nesse artigo é apresentado o novo recurso para interceptação do commit e validação do modelo MVC, permitindo uma melhor separação das operações pós gravação de modelo ( integrações com o ERP por exemplo) e validação de modelo, além de permitir o reuso dessas operações em localizações de formulários MVC.

Sobrescrevendo o bloco de Commit.

Atualmente quando é preciso realizar outras operações além da gravação do modelo no Commit do MVC (contabilização, integração fiscal, financeira e etc.) são utilizados os seguintes passos:

Criação do bloco de commit.
Dentro da função do bloco é executada a função FWFormCommit, para persistir o modelo.
Abre as tabelas do modelo e executa a leitura (novamente) do modelo, executando as operações de integração

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo bloco de commit
linenumbers	true
collapse	true

//-------------------------------------------------------------------
/*/{Protheus.doc} ModelDef
Definição do modelo de Dados
Data Model definition
@author alvaro.camillo
@since 05/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Static Function ModelDef()
Local oModel
Local oStr1		:= FWFormStruct(1,'ZC3')
Local oStr2		:= FWFormStruct(1,'ZC4')
//Bloco a ser executado no Commit
Local bCommit	:= {|oModel| MLOC003Com(oModel) }
oModel := MPFormModel():New('MLOC003Old', /*bPre*/, /*bPost*/, bCommit, /*bCancel*/)
oModel:SetDescription('Pedidos')
oModel:addFields('ZC3MASTER',,oStr1)
oModel:addGrid('ZC4DETAIL','ZC3MASTER',oStr2)
oModel:SetRelation('ZC4DETAIL', { { 'ZC4_FILIAL', 'xFilial("ZC4")' }, { 'ZC4_COD', 'ZC3_COD' } }, ZC4->(IndexKey(1)) )
Return oModel
 
//oModel:getModel('ZC3MASTER'):SetDescription('Pedido')
oModel:getModel('ZC4DETAIL'):SetDescription('Item do pedido')
oModel:AddCalc( 'Totalizador', 'ZC3MASTER', 'ZC4DETAIL', 'ZC4_TOTAL', 'ZC__TOTALPED', 'SUM', /*bCondition*/, /*bInitValue*/,'Total do Pedido' /*cTitle*/, /*bFormula*/)
Return oModel
 
//-------------------------------------------------------------------
/*/{Protheus.doc} MLOC003Com
Função de Commit
Commit Function
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Static Function MLOC003Com(oModel)
Local cPadrao 		:= "005" 						// Lançamento padrão a ser configurado no CT5 //Standard entries to be configured on CT5
Local nTotal 		:= 0 							//  Variável totalizadora da contabilizacao //Variable with accounting total
Local aFlagCTB		:= {} 							// Array com as informações para a gravação do flag de contabilização do registro//Array with informations for accounting flag record
Local nHdlPrv		:= 0 							// Handle (numero do arquivo de trabalho) utilizado na contabilizacao//Handler (working file number) used on accounting
Local cLote	  		:= LoteCont("FIN")				// Lote Contábil do lançamento, cada módulo tem o seu e está configurado na tabela 09 do SX5
//Temporary file used on accounting
Local cArquivo		:= "" 							// Arquivo temporario usado para contabilizacao
Local lMostra		:= .T. 							// Verifica se mostra ou nao tela de contabilização
Local lAglutina 	:= .F. 							// Verifica se aglutina lançamentos com as mesmas entidades contábeis
Begin Transaction
FWFormCommit( oModel )
// Função que verifica se o lançamento padrão foi configurado pelo cliente 
// Function which verify if the accounting entry was configured by customer
If VerPadrao(cPadrao)
	// Rotina que abre o capa do lote contábil ( Inicio da Contabilização)
	// Accounting beginning
	nHdlPrv := HeadProva(cLote,FunName(),Substr(cUsername,1,6),@cArquivo)
EndIf
ZC4->(dbSetOrder(1))//ZC4_FILIAL+ZC4_COD+ZC4_ITEM
ZC0->(dbSetOrder(1))//ZC0_FILIAL+ZC0_COD+ZC0_LOJA
ZC1->(dbSetOrder(1))//ZC1_FILIAL+ZC1_COD
ZC0->(MsSeek(xFilial("ZC0") + ZC3->(ZC3_CLIENT + ZC3_LOJA) ))
If ZC4->(dbSeek( xFilial("ZC4") + ZC3->ZC3_COD ))
	While ZC4->(!EOF()) .And. ZC4->(ZC4_FILIAL+ZC4_COD) == xFilial("ZC4") + ZC3->ZC3_COD 
		ZC1->(MsSeek(xFilial("ZC4") + ZC4->ZC4_PROD ))
		
		If nHdlPrv > 0  
			aAdd(aFlagCTB,{"ZC4_LA","S","ZC4",ZC4->(Recno()),0,0,0})	
			// Função que interpreta todas as sequencias de lançamento configurada pelo usuário e cria as linhas de lançamento contábil
			// Executada uma vez para cada registro que quer ser contabilizado
			nTotal += DetProva(nHdlPrv,cPadrao,FunName// Function which interpret all sequences of the standard entries and creates the accounting entries.
			// Executed once for each record which will be accounted for.
			
			nTotal += DetProva(nHdlPrv,cPadrao,FunName(),cLote,,,,,,,,@aFlagCTB)
		Endif
				
		ZC4->(dbSkip())
	EndDo
	If nHdlPrv > 0 .And. ( nTotal > 0 )
		// Função que fecha o lote contábil
		// Function that closes the accounting lot
		RodaProva(nHdlPrv, nTotal)         
		// Função que apresenta a tela de contabilização, realiza aglutinação caso necessária e grava o documento contábil ( CT2 )
		cA100Incl(cArquivo,nHdlPrv,// Function that shows the account dialog, performs the grouping if needed and records the accounting document ( CT2 )	
		cA100Incl(cArquivo,nHdlPrv,3,cLote,lMostra,lAglutina)
	Endif	
EndIf
End Transaction

Return .T.

Porém essa implementação tem limitações como:

Uso excessivo de bloco de código com gasto de memória e baixa performance.
É preciso realizar a leitura novamente dos registros para as operações de integração.
O controle de transação fica por conta do desenvolvedor.
Em um fonte localizado não é possível estender o comportamento do commit, incluindo novas operações.

O padrão Observer

O Observer é um padrão de projeto de software que define uma dependência um-para-muitos entre objetos de modo que quando um objeto muda o estado, todos seus dependentes são notificados e atualizados automaticamente. Permite que objetos interessados sejam avisados da mudança de estado ou outros eventos ocorrendo num outro objeto.(https://pt.wikipedia.org/wiki/Observer)

O padrão Observer no MVC Protheus - Utilizando a classe FWModelEvent

Em um fomulário MVC esse padrão é aplicado utilizando os seguintes passos:

Desenvolver uma classe que herde da classe FWModelEvent.
Inscrever um objeto dessa classe no modelo.

Desenvolvendo uma classe FWModelEvent

Essa classe será responsável pela a operação que complementa a persistência do modelo e a validação e será chamada toda vez que o formulário onde ele foi inscrito realize o commit ou realize alguma validação

Essa classe deve herdar da classe FWModelEvent e implementar os seguintes métodos:

Aviso

Painel

title	New

Sintaxe

FWModelEvent ():New()-> Objeto FWModelEvent

Descrição

Construtor da classe. Método Obrigatório para ser implementado

Painel

title	After

Sintaxe

FWModelEvent ():After(oSubModel, cModelId, cAlias, lNewRecord)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do commit
depois da gravação de cada submodelo (field ou cada linha de uma grid)

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Sub modelo
cModelId	Caracter	Id do submodelo
cAlias	Caracter	Alias do submodelo
lNewRecord	Lógico	Indica se é um registro novo.

Importante

É possível inscrever mais de um Evento ao formulário, permitindo a separação de comportamentos em classe diferentes ( classe para a contabilização, classe para a integração fiscal e etc)
Não é possível executar o bloco de commit e o padrão FwModelEvent ao mesmo tempo, caso aconteça o sistema irá gerar um erro de execução.
A função de entrada de um fonte MVC (chamada de menu) da rotina padrão deve ter no máximo 7 caracteres, pois a rotina localizada tem o seu nome somado a sigla do país.
Para o filtro de campos funcionar corretamente, na definição da view deve ser utilizada a função FwLoadModel para carregar o modelo. Não utilize ModelDef()

Essa classe deve herdar da classe FWModelEvent e implementar os seguintes métodos:

Painel

title	New

Sintaxe

FWModelEvent ():New()-> Objeto FWModelEvent

Descrição

Construtor da classe. Método Obrigatório para ser implementado

Painel

title	Destroy

Sintaxe

FWModelEvent ():Destroy()

Descrição

Destrutor da classe
Caso o evento utilize atributos como array,objetos é boa prática o desenvolvedor
limpar esses atributos da memória.

Utilize para limpar atributos que são array ou objetos.

Exemplo

Limpeza de array:

aSize(aArray, 0)

aArray := Nil

Limpeza de objeto

oObject := Nil

Painel

title	After

Painel

title	Before

Sintaxe

FWModelEvent ():BeforeAfter(oSubModel, cModelId, cAlias, lNewRecord)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do commit
antes depois da gravação de cada submodelo (field ou cada linha de uma grid)

ParâmetrosParâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Sub modelo


cModelId	Caracter	Id do submodelo


cAlias	Caracter	Alias do submodelo


lNewRecord	Lógico	Indica se é um registro novo.

Painel

title	AfterTTSBefore

Sintaxe

FWModelEvent ():AfterTTSBefore(oModeloSubModel, cModelId, cAlias, lNewRecord)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do após a transação.

Parâmetros

commit
antes da gravação de cada submodelo (field ou cada linha de uma grid)

Parâmetros

Nome

Tipo

Descrição

Default

Obrigatório

Referência

oModel

oSubModel

Objeto

Modelo principal

Sub modelo


cModelId

Caracter

Id do submodelo

cModelId


cAlias	Caracter

Id

Alias do submodelo


lNewRecord

Lógico

Indica se é um registro novo.

Painel

title	BeforeTTSAfterTTS

Sintaxe

FWModelEvent ():BeforeTTSAfterTTS(oModel, cModelId)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do commit antes da após a transação.

Esse evento ocorre uma vez no contexto do modelo principal.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oModel	Objeto	Modelo principal


cModelId	Caracter	Id do submodelo

Painel

title	InTTSBeforeTTS

Sintaxe

FWModelEvent ():InTTSBeforeTTS(oModel, cModelId)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do commit Após as gravações porém
antes do final da transação.

Esse evento ocorre uma vez no contexto do modelo principal.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oModel	Objeto	Modelo principal


cModelId	Caracter	Id do submodelo

Painel

title	ModelPreVldInTTS

Sintaxe

FWModelEvent ():ModelPreVldInTTS(oModel, cModelId) -> lOK

Descrição

Método que é chamado pelo MVC quando ocorrer as ações de pre validação do Model

Parâmetros

do commit Após as gravações porém
antes do final da transação.

Esse evento ocorre uma vez no contexto do modelo principal.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oModel	Objeto	Modelo principal


cModelId	Caracter	Id do submodelo


cAction	Caracter	Ação executada no grid, podendo ser: UNDELETE, DELETE, SETVALUE, CANSETVALUE
cId	Caracter	nome do campo
xValue	Variável	Novo valor do campo
xCurrentValue	Variável	Valor atual do campo

Caracter	Ação executada no grid, podendo ser: SETVALUE, CANSETVALUE
cId	Caracter	nome do campo
xValue	Caracter	Novo valor do campo

Status do documento	Desenvolvimento
Data	14/12/2016
Versão	1.0
Autores	Alvaro Camillo Neto

Páginas filhas

Versões comparadas

Versão antiga 28

Nova versão Atual

Chave

Conceito

Sobrescrevendo o bloco de Commit.

O padrão Observer

O padrão Observer no MVC Protheus - Utilizando a classe FWModelEvent

Desenvolvendo uma classe FWModelEvent

Inscrever um objeto no modelo.

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 28

Nova versão Atual

Chave

Conceito

Sobrescrevendo o bloco de Commit.

O padrão Observer

O padrão Observer no MVC Protheus - Utilizando a classe FWModelEvent

Desenvolvendo uma classe FWModelEvent

Inscrever um objeto no modelo.