Histórico da Página

...

Validação, Manutenção e acesso rápido a tabela “mab-item-abastec”.

Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-item-abastec”.

...

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.

Tabelas Temporárias

Nos atributos das tabelas temporárias:

...

Tabela Temporária	Descrição		Entrada/Saída
RowErrorsApont		Contém os erros ocorridos na BO da tabela “mab-abastec-lubrific”.	Entrada

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ErrorSequence	integer	padrão	Seqüência dos erros	Sim	001
ErrorNumber	integer	padrão	Número do erro	Sim	001
ErrorDescription	char	padrão	Descrição do erro	Sim	001
ErrorParameters	char	padrão	Parâmetros passados para criar mensagem	Não	001
ErrorType	char	padrão	Tipo do erro: WARNING: Aviso ERROR: Erro	Sim	001
ErrorHelp	char	padrão	Texto de ajuda do erro	Sim	001
ErrorSubType	char	padrão	Sub Tipo da mensagem de erro	Não	001

...

Método Básico

goToKey

Requisito	Nenhum
Sintaxe	run goToKey in h-handle (input <integer>, input <character>, input <character>, input <character>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pnum-docto	Número do Documento
	pcod-posto	Código do Posto de Combustível
	pcod-bomba	Código da Bomba
	pit-codigo	Código do Item de Estoque
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getKey

Requisito	Nenhum
Sintaxe	run getKey in h-handle (output <integer>, output <character>, output <character>, output <character>).
Descrição	Retorna os campos da chave primária da tabela.
		Parâmetros	Descrição
	pnum-docto	Número do Documento
	pcod-posto	Código do Posto de Combustível
	pcod-bomba	Código da Bomba
	pit-codigo	Código do Item de Estoque
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getCharField

Requisito	Nenhum
Sintaxe	run getCharField in h-handle (input <character>, output <character>).
Descrição	Retorna os valores dos campos da tabela que são caracteres.
		Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getDateField

Requisito	Nenhum
Sintaxe	run getDateField in h-handle (input <character>, output <date>).
Descrição	Retorna os valores dos campos da tabela que são data.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getDecField

Requisito	Nenhum
Sintaxe	run getDecField in h-handle (input <character>, output <decimal>).
Descrição	Retorna os valores dos campos da tabela que são decimais.
		Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getIntField

Requisito	Nenhum
Sintaxe	run getIntField in h-handle (input <character>, output <integer>).
Descrição	Retorna os valores dos campos da tabela que são inteiros.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getLogField

Requisito	Nenhum
Sintaxe	run getLogField in h-handle (input <character>, output <logical>).
Descrição	Retorna os valores dos campos da tabela que são Lógicos.
		Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getRawField

Requisito	Nenhum
Sintaxe	run getRawField in h-handle (input <character>, output <raw>).
Descrição	Retorna os valores dos campos da tabela que são caracteres longos.
		Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getRecidField

Requisito	Nenhum
Sintaxe	run getRecidField in h-handle (input <character>, output <recid>).
Descrição	Retorna os valores dos campos da tabela que são numéricos e definem uma seqüência única para a tabela dentro do database.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getRowid

Requisito	Nenhum
Sintaxe	run getRowid in h-handle (output <rowid>).
Descrição	Retorna o ROWID do registro corrente da Query que está aberta na BO. Este método não aparece para ser manutenido.
	Parâmetros	Descrição
	pRowid	Rowid da tabela.
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

...

OpenQuery / OpenQuery / SetConstraint / LinkTo

linkToApontamento

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela mab-abastec-lubrific.
Sintaxe	run linkToApontamento in h-handle (input <hanlde>).
Descrição	Faz o JOIN entre as tabelas “mab-abastec-lubrific” e “mab-item-abastec”. Recebe como parâmetro o handle da BO da tabela mab-abastec-lubrific, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintApontamento”.
	Parâmetros	Descrição
	pHandle	Handle da BO “mab-abastec-lubrific” (Apontamento Abastec/Lubrific.).
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintAbastecimento

Requisito	Nenhum
Sintaxe	run setConstraintAbastecimento in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <character>, input <character>, input <character>, input <character>,).
Descrição	Seta asretrições para as faixas da chave primária da tabela.
		Parâmetros	Descrição
	pDocIni	Documento inicial
	pDocFim	Documento final
	pPostoIni	Posto Inicial
	pPostoFim	Posto Final
	pBombaIni	Bomba Inicial
	pBombaFim	Bomba Final
	pItemIni	Item Inicial
	pItemFim	Item Final
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintApontamento

Requisito	Nenhum
Sintaxe	run setConstraintApontamento in h-handle (input <integer>).
Descrição	Seta as restrições para abrir a query por número do documento do apontamento.
		Parâmetros	Descrição
	pDocumento	Número do Documento
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintEquipamento

Requisito	Nenhum
Sintaxe	run setConstraintEquipamento in h-handle (input <integer>, input <integer>, input <character>, input <character>).
Descrição	Seta as retrições para as faixas de equipamento.
	Parâmetros	Descrição
	pEmpIni	Empresa Inicial
	pEmpFim	Empresa Final
	pEqptoIni	Equipamento Inicial
	pEqptoFim	Equipamento Final
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryAbastecimento

Requisito	A setConstraintAbastecimento ter sido executada anteriormente.
Sintaxe	run openQueryAbastecimento in h-handle.
Descrição	Abre a query com os registros da faixa da chave primária.
	Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryApontamento

...

Requisito

openQueryApontamento

Requisito	A setConstraintApontamento ter sido executada anteriormente.
Sintaxe	run openQueryApontamento in h-handle.
Descrição	Abre a query da BO conforme o número do documento do apontamento passado na procedure setConstraintApontamento.
	Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryApontPrimario

Requisito	A setConstraintApontamento ter sido executada anteriormente.
Sintaxe	run openQueryApontPrimario in h-handle.
Descrição	Abre a query da BO conforme o número do documento do apontamento passado na procedure setConstraintApontamento traz somente os apontamentos de combustível primário.
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryEquipamento

Requisito	A setConstraintEquipamento ter sido executada anteriormente.
Sintaxe	run openQueryEquipamento in h-handle.
Descrição	Abre a query com os registros da faixa de equipamento.
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryMain

Requisito	Nenhum
Sintaxe	run openQueryMain in h-handle.
Descrição	Abre a query da BO com todos os registros.
	Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

...

Método Negócio

validateRecord

Requisito	Ter sido executada alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.
Sintaxe	run validate in this-procedure (input <character>).
Descrição	Valida as ações feitas em cima do registro da tabela corrente da BO. Estas ações podem ser: “CREATE”, “UPDATE” e “DELETE”.
	Parâmetros	Descrição
	pType	Tipo de ação: “CREATE” “UPDATE” “DELETE”
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

validaEstoque

...

Requisito

validaEstoque

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validaEstoque in this-procedure (input <character>).
Descrição	Faz as validações para os atributos do estoque. it-codigo = Código do Item cod-refer = Código da Referência cod-localiz = Código da Localização lote = Código do Lote
	Parâmetros	Descrição
	pPosto	Código do Posto de Abastecimento
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

validaItem

Requisito	Nenhum.
Sintaxe	run validaItem in this-procedure (input <integer>, input <character>, input <character>, input <character>, input <character>, input <date>).
Descrição	Valida se item informado está relacionado a um Tipo de Material e se este tipo de material está associado a bomba do posto, quando o posto abastecimento for próprio.
		Parâmetros	Descrição
	pEmpresa	Código da Empresa
	pEqpto	Código do equipamento
	pPosto	Código do Posto
	pBomba	Código da bomba
	pItem	Código do Item
	pData	Data do Movimento
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

afterCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run afterCreateRecord in this-procedure.
Descrição	Verifica se execução da API de consistência dos Abastec./Lubrific. será feita.
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

afterDeleteRecord

Requisito	Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.
Sintaxe	run afterDeleteRecord in this-procedure.
Descrição	Verifica se o movimento de abastecimento eliminado, está integrado com estoque. Se estiver integrado, será gerado um movimento de Devolução dos materiais na CPAPI001 (API de estoque). Se o programa que estiver executando a BO for o AB0306 (Apontamentos de Abastecimento), chama a procedure “piEliminaFicha”, para validar a eliminação da Ficha de Abastecimento/Lubrificação.
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

afterUpdateRecord

Requisito	Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.
Sintaxe	run afterUpdateRecord in this-procedure.
Descrição	Verifica se execução da API de consistência dos abastec./Lubrific. será feita.
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

beforeDeleteRecord

Requisito	Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.
Sintaxe	run beforeDeleteRecord in this-procedure.
Descrição
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

piEliminaFicha

Requisito	Procedure chamada pelo método interno afterDeleteRecord. Não deve ser chamada externamente.
Sintaxe	run piEliminaFicha in this-procedure.
Descrição	Verifica se a Ficha de Abastecimento/Lubrificação contém mais abastecimentos ou lubrificações, se não tiver mais relacionamentos, chama a BO (bofr055), para eliminação da ficha, utilizando as validações da BO. Se ocorreu erro na eliminação, os erros serão mostrados em tela. Obs: Esta procedure é utilizada pelo programa de Apontamento de Abastecimento (AB0306).
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

buscaTipoMaterial

Requisito	Nenhum
Sintaxe	run buscaTipoMaterial in h-handle (input <integer>, input <character>, input <character>, input <date>, output <character>, output <logical>, output <decimal>).
Descrição	Verifica qual o tipo de material do item de estoque informado e retorna se é um abastecimento primário e a capacidade de armazenamento no tanque de combustível.
		Parâmetros	Descrição
	pEmpresa	Código da Empresa
	pEqpto	Código do Equipamento
	pItem	Código do Item de Estoque
	pData	Data do Apontamento
	pTipo	Código do Tipo de Material
	pLog	Abastecimento Primário?
	pTanque	Valor da capacidade do tanque de combustível
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

buscaTipoPosto

Requisito	Nenhum
Sintaxe	run buscaTipoPosto in h-handle (input <character>, output <integer>).
Descrição	Busca o tipo de posto de combustível. 1 = Próprio 2 = Terceiros
		Parâmetros	Descrição
	pPosto	Código do Posto de Combustível
	pTipo	Tipo de posto 1 = Próprio 2 = Terceiros
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

piChamaABAPI001

Requisito	Nenhum
Sintaxe	run piChamaABAPI001 in h-handle.
Descrição	Chama a API de Atualização das fichas de abastecimento/lubrificação.
	Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

setaPrograma

Requisito	Nenhum
Sintaxe	run setaPrograma in h-handle.
Descrição	Seta o Programa chamador da BO
		Parâmetros	Descrição
	pPrograma	Código do programa
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

sendMessageEAI

Requisito	Nenhum.
Sintaxe	run sendMessageEAI in this-procedure.
Descrição	Gera uma msg xml caso houver integração com agroindustria.
	Parâmetros	Descrição
	tt-mab-abastec-lubrific-eai	Temp-table
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

setaExecutaAPI

Requisito	Nenhum
Sintaxe	run setaExecutaAPI in h-handle.
Descrição	Informa se executa API de atualização das fichas (ABAPI001)
	Parâmetros	Descrição
	pExecutaAPI	Executa API ABAPI001
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro....

pi-cria-tt-movto-un

Requisito	Procedure chamada pelo método interno afterDeleteRecord. Não deve ser chamada externamente.
Sintaxe	run pi-cria-tt-movto-un in this-procedure.
Descrição	Cria a temp-table de Unidade de Negócio com base na Matriz do Histórico.
		Parâmetros	Descrição
	Não Contém
Retorno	A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table tt-erro.

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

Funcionamento

Tabelas Temporárias

goToKey

getKey

getCharField

getDateField

getDecField

getIntField

getIntField

getLogField

getRawField

getRecidField

getRowid

linkToApontamento

setConstraintAbastecimento

setConstraintApontamento

setConstraintEquipamento

openQueryAbastecimento

openQueryApontamento

openQueryApontamento

openQueryApontPrimario

openQueryEquipamento

openQueryMain

validateRecord

validaEstoque

validaEstoque

validaItem

afterCreateRecord

afterDeleteRecord

afterUpdateRecord

beforeDeleteRecord

piEliminaFicha

buscaTipoMaterial

buscaTipoPosto

piChamaABAPI001

setaPrograma

sendMessageEAI

setaExecutaAPI

pi-cria-tt-movto-un