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 dessa 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
Local nTotal //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

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(),cLote,,,,,,,,// 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,// 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 FWObserverclasse FWModelEvent.
Inscrever um objeto dessa classe no modelo.

Desenvolvendo uma

classe Observer

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 .

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

Painel

title	Delete

Sintaxe

FWObserver():New()-> Objeto FWObserver

Descrição

Construtor da classe

Painel

title	New

Sintaxe

FWObserver():update(oObserver,cAction,aParam)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do commit.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oObserver	Objeto	Objeto do Observer
cAction	Caracter	Tipo da ação que está sendo executada pelo commit: BEFORE_TTS: Antes do início da transação IN_TTS: Após as gravações porém antes do final da transação AFTER_TTS: Após a transação BEFORE: Antes da gravação de cada submodelo (field ou cada linha de uma grid) AFTER: Depois da gravação de cada submodelo (field ou cada linha de uma grid)
aParam	Array	Array com dados para ajudar a implementação da ação. Cada ação terá um conjunto de dados no array: BEFORE_TTS,IN_TTS,AFTER_TTS: Apenas o submodelo ({oModel}) BEFORE e AFTER : Array com os seguintes elementos: aParam[1] = Sub modelo aParam[2] = Id do submodelo aParam[3] = Alias do submodelo aParam[4] = lNewRecord - Indica se é um registro novo.

ou realize alguma validação

Aviso

title	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

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.

Painel

title	Before

Sintaxe

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

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do 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
oSubModel	Objeto	Sub modelo
cModelId	Caracter	Id do submodelo
cAlias	Caracter	Alias do submodelo
lNewRecord	Lógico	Indica se é um registro novo.

Painel

title	AfterTTS

Sintaxe

FWModelEvent ():AfterTTS(oModel, cModelId)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do 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	BeforeTTS

Sintaxe

FWModelEvent ():BeforeTTS(oModel, cModelId)

Descrição

Método que é chamado pelo MVC quando ocorrer as ações do commit antes 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	InTTS

Sintaxe

FWModelEvent ():InTTS(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	Activate

Sintaxe

FWModelEvent ():Activate(oModel, lCopy)

Descrição

Método que é chamado pelo MVC quando ocorrer a ativação do Model.

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
lCopy	Lógico	Informa se o model deve carregar os dados do registro posicionado em operações de inclusão. Essa opção é usada quando é necessário fazer uma operação de cópia.

Painel

title	DeActivate

Sintaxe

FWModelEvent (): DeActivate(oModel)

Descrição

Método que é chamado pelo MVC quando ocorrer a desativação do Model.

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

Painel

title	VldActivate

Sintaxe

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

Descrição

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

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	ModelPreVld

Sintaxe

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

Descrição

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

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	ModelPosVld

Sintaxe

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

Descrição

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

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	GridPosVld

Sintaxe

FWModelEvent ():GridPosVld(oSubModel, cModelID) -> lOK

Descrição

Método que é chamado pelo MVC quando ocorrer as ações de pós validação do Grid

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Modelo principal
cModelId	Caracter	Id do submodelo

Painel

title	GridLinePreVld

Sintaxe

FWModelEvent ():GridLinePreVld(oSubModel, cModelID, nLine, cAction, cId, xValue, xCurrentValue) -> lOK

Descrição

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

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Modelo principal
cModelId	Caracter	Id do submodelo
nLine	Numérico	Linha do grid
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

Painel

title	GridLinePosVld

Sintaxe

FWModelEvent ():GridLinePosVld(oSubModel, cModelID, nLine) -> lOK

Descrição

Método que é chamado pelo MVC quando ocorrer as ações de pos validação da linha do Grid

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Modelo principal
cModelId	Caracter	Id do submodelo
nLine	Numérico	Linha do grid

Painel

title	FieldPreVld

Sintaxe

FWModelEvent ():FieldPreVld(oSubModel, cModelID, cAction, cId, xValue) -> lOK

Descrição

Método que é chamado pelo MVC quando ocorrer a ação de pré validação do Field

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Modelo principal
cModelId	Caracter	Id do submodelo
cAction	Caracter	Ação executada no grid, podendo ser: SETVALUE, CANSETVALUE
cId	Caracter	nome do campo
xValue	Caracter	Novo valor do campo

Painel

title	FieldPosVld

Sintaxe

FWModelEvent ():FieldPosVld(oSubModel, cModelID) -> lOK

Descrição

Método que é chamado pelo MVC quando ocorrer a ação de pós validação do Field

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
oSubModel	Objeto	Modelo principal
cModelId	Caracter	Id do submodelo

Painel

title	GetEvent

Sintaxe

FWModelEvent ():GetEvent(cIdEvent) -> oEvent

Descrição

Método que retorna um evento superior da cadeia de eventos.
Através do método InstallEvent, é possível encadear dois eventos que estão relacionados, como por exemplo um
evento de negócio padrão e um evento localizado que complementa essa regra de negócio.
Caso o evento localizado, necessite de atributos da classe superior, ele irá utilizar esse método para recuperá-lo.

Parâmetros

Nome	Tipo	Descrição	Default	Obrigatório	Referência
cIdEvent	Caracter	Id do Evento Superior.

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de classe FwModelEvent (Simples)
linenumbers	true
collapse	true

#Include 'Protheus.ch'
#Include 'FWMVCDef.ch'
//-------------------------------------------------------------------
/*/{Protheus.doc} ML003PRORUS
Classe interna implementando o FWModelEvent
Intern class inherited from FWModelEvent.
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Class ML003PRORUS FROM FWModelEvent
	Method After()
	Method New()
End Class
Method New() Class ML003PRORUS
Return
Method After(oModel, cModelId, cAlias, lNewRecord) Class ML003PRORUS
If cAlias == "ZC4" .And. lNewRecord
	ZL1->(dbSetOrder(1))//ZL1_FILIAL+ZL1_COD
	If ZL1->(MsSeek(xFilial("ZL1") + ZC4->ZC4_PROD ))
		RecLock("ZL1",.F.)
			ZL1->ZL1_QTVEND += ZC4->ZC4_QUANT  
		MsUnLock()
	EndIf
EndIf		
Return

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de classe FwModelEvent (Contabilização)
linenumbers	true
collapse	true

 #Include 'Protheus.ch'
#Include 'FWMVCDef.ch'
//-------------------------------------------------------------------
/*/{Protheus.doc} ML003CTB
Classe interna implementando o FWModelEvent
Intern class inherited from FWModelEvent.
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Class ML003CTB FROM FWModelEvent
	//Lançamento padrão a ser configurado no CT5
	//Standard entries to be configured on CT5
	DATA cPadrao
	//Variável totalizadora da contabilizacao 
	//Variable with accounting total
	DATA nTotal
	//Array com as informações para a gravação do flag de contabilização do registro 
	//Array with informations for accounting flag record
	DATA aFlagCTB
	//Handle (numero do arquivo de trabalho) utilizado na contabilizacao 
	//Handler (working file number) used on accounting
	DATA nHdlPrv
	//Arquivo temporario usado para contabilizacao  
	//Temporary file used on accounting
	DATA cArquivo
	DATA cLote
	
	Method new()
	Method After()
	Method AfterTTS()
	Method BeforeTTS()
	
	Method ModelPosVld()
	Method GridLinePreVld()
	Method openCTB()
	Method closeCTB()
	Method writeLineCTB()
	
	Method Destroy()
End Class
Method new ()  Class ML003CTB
	self:cPadrao 		:= "005" 						
	self:nTotal 		:= 0 							
	self:aFlagCTB		:= {} 							
	self:nHdlPrv		:= 0 							
	self:cLote			:= ""
	self:cArquivo		:= ""
Return
 
Method Destroy()  Class ML003CTB		
	self:aFlagCTB := aSize(self:aFlagCTB,0)
	self:aFlagCTB := Nil					
Return
//-------------------------------------------------------------------
/*/{Protheus.doc} BeforeTTS
Inicio da transação com a abertura do lote contabil
Transaction beginning and the oppening of lot accounting
@author Rodrigo Antonio
@version P12
/*/
//-------------------------------------------------------------------
Method BeforeTTS(oModel, cModelId) Class ML003CTB
	self:openCTB(oModel)	
Return
//-------------------------------------------------------------------
/*/{Protheus.doc} After
Executado após a gravaçao de cada linha para realizar lançamento contábil
Runs after every line recording to execute the accounting entries
@author Rodrigo Antonio
@version P12
/*/
//-------------------------------------------------------------------
Method After(oModel, cModelId, cAlias, lNewRecord)  Class ML003CTB
	self:writeLineCTB(oModel,cModelId,cAlias,lNewRecord) 
Return
//-------------------------------------------------------------------
/*/{Protheus.doc} AfterTTS
Fechamento da contabilização.
Accounting closing.
@author Rodrigo Antonio
@version P12
/*/
//-------------------------------------------------------------------
Method AfterTTS(oModel, cModelId)  Class ML003CTB
	self:closeCTB(oModel)
Return

//-------------------------------------------------------------------
/*/{Protheus.doc} openCTB
Metodo para ser executado antes da transação para abrir o header de contabilização
Method to be executed before the accounting header openning transaction
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Method openCTB(oModel) Class ML003CTB
//Lançamento padrão a ser configurado no CT5
//Standard entries to be configured on CT5
self:cPadrao 		:= "005"
//Variável totalizadora da contabilizacao 
//Variable with accounting total
self:nTotal 		:= 0
//Array com as informações para a gravação do flag de contabilização do registro 
//Array with informations for accounting flag record
self:aFlagCTB		:= {}
//Handle (numero do arquivo de trabalho) utilizado na contabilizacao 
//Handler (working file number) used on accounting
self:nHdlPrv		:= 0
// Lote Contábil do lançamento, cada módulo tem o seu e está configurado na tabela 09 do SX5
//accounting lot. Each model has a corresponding lot configured on the table 09 of SX5 
self:cLote	  		:= LoteCont("FIN")
//Arquivo temporario usado para contabilizacao  
//Temporary file used on accounting
self:cArquivo		:= ""
// 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(self:cPadrao)
	// Rotina que abre o lote contábil ( Inicio da Contabilização)
	// Accounting beginning
	self:nHdlPrv := HeadProva(self:cLote,FunName(),Substr(cUsername,1,6),@self:cArquivo)
EndIf
Return 
//-------------------------------------------------------------------
/*/{Protheus.doc} writeLineCTB
Metodo para ser executado depois da gravação.
Method to be executed after the data recording
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Method writeLineCTB(oModel,cModelId,cAlias,lNewRecord) Class ML003CTB
	Local aArea:= GetArea()
	If cAlias == "ZC4"
		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) ))
		ZC1->(MsSeek(xFilial("ZC4") + ZC4->ZC4_PROD ))
		
		If self:nHdlPrv > 0  
			aAdd(self: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
			// Function which interpret all sequences of the standard entries and creates the accounting entries.
			// Executed once for each record which will be accounted for.
			self:nTotal += DetProva(self:nHdlPrv,self:cPadrao,FunName(),self:cLote,,,,,,,,@self:aFlagCTB)
		Endif
	Endif
	RestArea(aArea)
Return
//-------------------------------------------------------------------
/*/{Protheus.doc} closeCTB
Metodo para ser executado depois da transação.
Method to be executed after the transaction.
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Method closeCTB(oModel) Class ML003CTB
// Verifica se mostra ou nao tela de contabilização
// Verify if accounting dialog will to be shown
Local lMostra	:= .T.
// Verifica se aglutina lançamentos com as mesmas entidades contábeis
// Verify if it's needed to group entries with the same accounting entities'
Local lAglutina := .F.
If self:nHdlPrv > 0 .And. ( self:nTotal > 0 )
	// Função que fecha o lote contábil
	// Function that closes the accounting lot
	RodaProva(self:nHdlPrv, self:nTotal)
	// Função que apresenta a tela de contabilização, realiza aglutinação caso necessária e grava o documento contábil ( CT2 )
	// Function that shows the account dialog, performs the grouping if needed and records the accounting document ( CT2 )
	cA100Incl(self:cArquivo,self:nHdlPrv,3,self:cLote,lMostra,lAglutina)
Endif
Return

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de classe observer (Simples)
linenumbers	true
collapse	true

#Include 'Protheus.ch'
#Include 'FWMVCDef.ch'
//-------------------------------------------------------------------
/*/{Protheus.doc} ML003PRORUS
Classe interna implementando o Observer do Commit para atualização de saldo no produto
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Class ML003PRORUS FROM FWObserver
	Method New()
	Method update()
End Class
Method update(oObserver,cAction,aParam) Class ML003PRORUS
Local oModel 	:= Nil
Local cModelId	:= ""
Local cAlias	:= ""
Local lNewRecord:= .F.

If cAction =="AFTER"
	oModel := aParam[1]
	cModelId:= aParam[2]
	cAlias:= aParam[3]
	lNewRecord:= aParam[4]
	If cAlias == "ZC4" .And. lNewRecord
		ZL1->(dbSetOrder(1))//ZL1_FILIAL+ZL1_COD
		If ZL1->(MsSeek(xFilial("ZL1") + ZC4->ZC4_PROD ))
			RecLock("ZL1",.F.)
				ZL1->ZL1_QTVEND += ZC4->ZC4_QUANT  
			MsUnLock()
		EndIf
		
	EndIf		
EndIf
return
Method new() Class ML003PRORUS
Return

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de classe observer (Contabilização)
linenumbers	true
collapse	true

#Include 'Protheus.ch'
#Include 'FWMVCDef.ch'/*/{Protheus.doc} ModelPos
Metodo de pos validação do modelo.
Model post validation method.
@author Guilherme Spadaccia
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Method ModelPosVld(oModel, cModelId) Class ML003CTB
Local lRet := .T.
//Defino o model que irei validar
//Define which model will be validated
If cModelId == 'MLOC003'
	If oModel:GetValue('ZC3MASTER','ZC3_COD') == "000000"
		lRet := .F.
		Help("",1,"VALID",,"Code 000000 is reserved",1,0)
	EndIf
EndIf
Return lRet

//-------------------------------------------------------------------
/*/{Protheus.doc} ML003CTB
Classe interna implementando o Observer do Commit
@author alvaro.camilloGridLinePre
Metodo de pré validação da linha da Grid.
Grid line pre validation method.
@author Guilherme Spadaccia
@since 06/09/2016
@version 1.0
/*/
//------------------------------------------------------------------------------------
Method GridLinePreVld(oSubModel, cModelID, nLine, cAction, cId, xValue, xCurrentValue) Class ML003CTB
Local lRet := .T.
If cModelID == "ZC4DETAIL"
	If cAction == "SETVALUE" .And. cId == "ZC4_QUANT"
		If xValue%2 > 0
			lRet := .F.
			Help("",1,"VALID",,"Only pair quantities are accepted",1,0)
		EndIf
	EndIf
EndIf
Return lRet

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de classe FwModelEvent derivada de outro evento já implementado (Localização)
linenumbers	true
collapse	true

#Include 'Protheus.ch'
#Include 'FWMVCDef.ch'
//-------------------------------------------------------------------
/*/{Protheus.doc} ML003CTBRUS
Classe interna implementando o FWModelEvent localizando para  padrão Russo
Intern class inherited from FWModelEvent for russian Standard.
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Class ML003CTBRUS FROM FWModelEvent
	
	Method New()
	Method After()
	Method ModelPosVld()
	Method GridLinePreVld()
End Class

Method New() Class ML003CTBRUS
Class ML003CTB FROM FWObserver
	DATA cPadrao 							// Lançamento padrão a ser configurado no CT5
	DATA nTotal 							//  Variável totalizadora da contabilizacao
	DATA aFlagCTB							// Array com as informações para a gravação do flag de contabilização do registro
	DATA nHdlPrv							// Handle (numero do arquivo de trabalho) utilizado na contabilizacao
	DATA cLote			
	DATA cArquivo							// Arquivo temporario usado para contabilizacao
	
	Method new()
	Method update()
	Method openCTB()
	Method closeCTB()
	Method writeLineCTB()
End Class
Method update(oObserver,cAction,aParam) Class ML003CTB
Local oModel 	:= Nil
Local cModelId	:= ""
Local cAlias	:= ""
Local lNewRecord:= .F.
If cAction =="BEFORE_TTS"
	oModel := aParam[1]
	self:openCTB(oModel)	
EndIf
If cAction =="AFTER"
	oModel := aParam[1]
	cModelId:= aParam[2]
	cAlias:= aParam[3]
	lNewRecord:= aParam[4]
	self:writeLineCTB(oModel,cModelId,cAlias,lNewRecord)	
EndIf
If cAction == "AFTER_TTS"
	oModel := aParam[1]
	self:closeCTB(oModel)	
EndIf
return
Method new ()  Class ML003CTB
	self:cPadrao 		:= "005" 						
	self:nTotal 		:= 0 							
	self:aFlagCTB		:= {} 							
	self:nHdlPrv		:= 0 							
	self:cLote			:= ""
	self:cArquivo		:= ""
Return
//-------------------------------------------------------------------
/*/{Protheus.doc} openCTBAfter
BlocoMétodo para ser executado antesdepois da transação para abrir o header de contabilizaçãogravação.
Method to be executed after the data recording
@author alvaro.camillo
@since 06/09/2016
@version 1.0
/*/
//----------/
//---------------------------------------------------------
Method openCTB(oModel) Class ML003CTB
Local lRet	:= .T. 							
self:cPadrao 		:= "005" 						// Lançamento padrão a ser configurado no CT5
self:nTotal 		:= 0 							//  Variável totalizadora da contabilizacao
self:aFlagCTB		:= {} 							// Array com as informações para a gravação do flag de contabilização do registro
self:nHdlPrv		:= 0 							// Handle (numero do arquivo de trabalho) utilizado na contabilizacao
self:cLote	  		:= LoteCont("FIN")				// Lote Contábil do lançamento, cada módulo tem o seu e está configurado na tabela 09 do SX5
self:cArquivo		:= "" 							// Arquivo temporario usado para contabilizacao
// Função que verifica se o lançamento padrão foi configurado pelo cliente 
If VerPadrao(self:cPadrao)
	// Rotina que abre o capa do lote contábil ( Inicio da Contabilização)
	self:nHdlPrv := HeadProva(self:cLote,FunName(),Substr(cUsername,1,6),@self:cArquivo)
EndIf
Return lRet----------
Method After(oModel,cModelId,cAlias,lNewRecord) Class ML003CTBRUS
Local aArea:= GetArea()
Local oEventCtb := self:GetEvent("ML003CTB")
If cAlias == "ZL4"
	If oEventCtb:nHdlPrv > 0  
		aAdd(oEventCtb:aFlagCTB,{"ZL4_LA","S","ZL4",ZL4->(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
		// Function which interpret all sequences of the standard entries and creates the accounting entries.
		// Executed once for each record which will be accounted for.
		oEventCtb:nTotal += DetProva(oEventCtb:nHdlPrv,"006",FunName(),oEventCtb:cLote,,,,,,,,@oEventCtb:aFlagCTB)
	Endif
Endif
RestArea(aArea)
Return 
//-------------------------------------------------------------------
/*/{Protheus.doc} writeLineCTB
Bloco para ser executado depois da gravação.
@author alvaro.camilloModelPos
Metodo de pos validação do modelo.
Model post validation method.
@author Guilherme Spadaccia
@since 06/09/2016
@version 1.0
/*/
//-------------------------------------------------------------------
Method writeLineCTB(oModel,cModelId,cAlias,lNewRecord) Class ML003CTB
Local lRet := .T.
Local aArea:= GetArea()
If cAlias == "ZC4"
	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) ))
	ZC1->(MsSeek(xFilial("ZC4") + ZC4->ZC4_PROD ))
	
	If self:nHdlPrv > 0  
		aAdd(self: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
		self:nTotal += DetProva(self:nHdlPrv,self:cPadrao,FunName(),self:cLote,,,,,,,,@self:aFlagCTB)
	Endif
Endif
RestArea(aArea)
----------
Method ModelPosVld(oModel, cModelId) Class ML003CTBRUS
Local lRet := .T.
//Defino o model que irei validar
If cModelId == 'MLOC003'
	If oModel:GetValue('ZC3MASTER','ZC3_COD') == "000001"
		lRet := .F.
		Help("",1,"VALID",,"Code 000001 is reserved in Russia.",1,0)
	EndIf
EndIf
Return lRet
//-------------------------------------------------------------------
/*/{Protheus.doc} closeCTBGridLinePre
BlocoMetodo de parapré servalidação executadoda depoislinha da transação Grid.
Grid line pre validation method.
@author Guilherme alvaro.camilloSpadaccia
@since 06/09/2016
@version 1.0
/*/
//---------------
/*/
//----------------------------------------------------
Method closeCTB(oModel) Class ML003CTB
Local lRet := .T.
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
If self:nHdlPrv > 0 .And. ( self:nTotal > 0 )
	// Função que fecha o lote contábil
	RodaProva(self:nHdlPrv, self:nTotal)         
	// Função que apresenta a tela de contabilização, realiza aglutinação caso necessária e grava o documento contábil ( CT2 )
	cA100Incl(self:cArquivo,self:nHdlPrv,3,self:cLote,lMostra,lAglutina)
Endif

Return lRet

 ----------------
Method GridLinePreVld(oSubModel, cModelID, nLine, cAction, cId, xValue, xCurrentValue) Class ML003CTBRUS
Local lRet := .T.
If cModelID == "ZC4DETAIL"
	If cAction == "SETVALUE" .And. cId == "ZC4_QUANT"
		If xValue > 10
			lRet := .F.
			Help("",1,"VALID",,"Only quantities under 10 are accepted",1,0)
		EndIf
	EndIf
EndIf
Return lRet

Inscrever um objeto no modelo.

Nessa etapa, no formulário MVC é preciso inscrever o objeto pelo método InstallObservermétodo InstallEvent:

Painel

title	NewInstallEvent

Sintaxe

MPFormModel():InstallObserverInstallEvent(cEventcIdEvent, cOwner, oObserveroEvent)

Descrição

Método de inscrição de observer

Parâmetros

de inscrição de objeto FwModelEvent

Através do método InstallEvent, é possível encadear dois eventos que estão relacionados, como por exemplo um
evento de negócio padrão e um evento localizado que complementa essa regra de negócio.

Parâmetros

Nome

Tipo

Descrição

Default

Obrigatório

Referência

cEvent

cIdEvent

Carácter

Sempre deve ser "COMMIT"

Id do Evento		Sim
cOwner	Carácter

Sim

COMMIT

oObserver

Objeto

Objeto que herde da classe FwObserver()

Sim

Importante

É possível inscrever mais de um observer 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)

Id do Evento Superior		Não
oEvent	Objeto	Evento do Modelo		Sim

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de inscrição de evento
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
/*/

Não é possível executar o bloco de commit e o padrão observer ao mesmo tempos, caso aconteça o sistema irá gerar um erro de execução.

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de inscrição de observer
linenumbers	true
collapse	true

//-------------------------------------------------------------------
/*/{Protheus.doc} ModelDef
Definição do modelo de Dados
@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')
Local oObserver := ML003CTB():New()
oModel := MPFormModel():New('MLOC003', /*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)) )
//Inscrição do observer ML003CTB
oModel:InstallObserver("COMMIT",oObserver)
Return oModelStatic Function ModelDef()
Local oModel
Local oStr1		:= FWFormStruct(1,'ZC3')
Local oStr2		:= FWFormStruct(1,'ZC4')
Local oEvent  := ML003CTB():New()
oModel := MPFormModel():New('MLOC003', /*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)) )
oModel:getModel('ZC3MASTER'):SetDescription('Pedido')
oModel:getModel('ZC4DETAIL'):SetDescription('Item do pedido')
oModel:getModel('ZC4DETAIL'):SetUseOldGrid( .T. )
oModel:AddCalc( 'Totalizador', 'ZC3MASTER', 'ZC4DETAIL', 'ZC4_TOTAL', 'ZC__TOTALPED', 'SUM', /*bCondition*/, /*bInitValue*/,'Total do Pedido' /*cTitle*/, /*bFormula*/)
oModel:InstallEvent("ML003CTB", /*cOwner*/, oEvent)
Return oModel

Bloco de código

language	cpp
theme	Eclipse
firstline	1
title	Exemplo de inscrição de observer evento em um fonte localizado
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		:= FWLoadModel('MLOC003')
Local oStr2		:= FWFormStruct(1,'ZL4')
Local oObsCTB		:= ML003CTBRUS():New()
Local oObsProduto	:= ML003PRORUS():New()
oModel:addGrid('ZL4DETAIL','ZC4DETAIL',oStr2)
oModel:SetRelation('ZL4DETAIL', { { 'ZL4_FILIAL', 'xFilial("ZL4")' }, { 'ZL4_COD', 'ZC3_COD' }, { 'ZL4_ITEM', 'ZC4_ITEM' } }, ZL4->(IndexKey(1)) )
oModel:getModel('ZL4DETAIL'):SetDescription('Rateio do Item Russo')
oModel:getModel('ZL4DETAIL'):SetOptional(.T.)
//LimpaInstala oso observerevento poisde oatualização observer da contabilização será herdado de saldo
//Install Balance update Event
oModel:ClearObserverInstallEvent("COMMITML00PRORUS", , oObsProduto)
//Instala o observerevento de contabilizao Russa
oModel:InstallObserver("COMMIT",oObsCTB)
//InstalaInstall oRussian observer de atualização de saldoAccounting Event
oModel:InstallObserverInstallEvent("ML003CTBRUS", "COMMITML003CTB",oObsProduto oObsCTB)

Return oModel

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

Índice

outline	true
indent	10px

Páginas filhas

Versões comparadas

Versão antiga 15

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 15

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.