Histórico da Página

Requisito

Nenhum

Sintaxe

run goToKey in h-handle (input <integer>,

                         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-comptmento

Código do Compartimento

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.

Requisito

Nenhum

Sintaxe

run getKey in h-handle (output <integer>,

                        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-comptmento

Código do Compartimento

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.

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.

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.

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.

Requisito

Nenhum

Sintaxe

run

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.

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.

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.

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.

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.

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-lubrific”.

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.

Requisito

Nenhum

Sintaxe

run setConstraintAmostra in h-handle (input <integer>).

Descrição

Seta as restrições para abrir a query.

Parâmetros

Descrição

pep-codigo     

Código da empresa

pcod-eqpto     

Código do equipamento

pcod-comptmento

Código do compartimento

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.

Requisito

Nenhum

Sintaxe

run setConstraintEquipamento in h-handle (input <integer>,

                                          input <integer>,

                                          input <character>,

                                          input <character>,

                                          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

pComtpIni

Código do compartimento inicial

pComtpFim

Código do compartimento 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.

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.

Requisito

Nenhum

Requisito

Nenhum

Sintaxe

run setConstraintFiltro in h-handle (input <integer>).

Descrição

Seta as retrições para as faixas de equipamento.

Parâmetros

Descrição

p-item-ini

Número do item inicial

p-item-fim

Número do item final

p-datahora-ini

Data hora inicial

p-datahora-fim

Data hora final

p-evento-ini

Número do evento inicial

p-evento-fim

Número do evento final

p-lubrific-ini

Número da lubrificação inicial

p-lubrific-fim

Número da lubrificação 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.

Requisito

Nenhum

Sintaxe

run setConstraintDocumento in h-handle (input <integer>).

Descrição

Seta as amostra de Óleo.

Parâmetros

Descrição

pDoctoIni

Numero do Documento Inicial

pDoctoFim

Numero do Documento Final

pAmostraIni

Numero da amostra física inicial

pAmostraFim

Numero da amostra física 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.

Requisito

Nenhum

Sintaxe

run setConstraintMaterial in h-handle (input <integer>).

Descrição

Seta as amsotrar de Óleo pelo código do material e do Item.

Parâmetros

Descrição

pMaterIni

Código do material Inicial

pMaterFim

Código do material Final  

pItemIni

Código do  Item inicial   

ptemFim 

Código do  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.

Requisito

A setConstraintAmostra ter sido executada anteriormente.

Sintaxe

run openQueryAmostra in h-handle.

Descrição

Abre a query da BO conforme os campos passados na procedure setConstraintAmostra.

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.

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.

Requisito

Requisito

A setConstraintDocumento ter sido executada anteriormente.

Sintaxe

run openQueryDocumento in h-handle.

Descrição

Abre a query da BO conforme os campos e faixas passados na procedure setConstraintDocumento.

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.

Requisito

A setConstraintEquipamento ter sido executada anteriormente.

Sintaxe

run openQueryEquipamento in h-handle.

Descrição

Abre a query da BO conforme os campos e faixas passados na procedure setConstraintEquipamento.

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.

Requisito

A setConstraintFiltro ter sido executada anteriormente.

Sintaxe

run openQueryFiltro in h-handle.

Descrição

Abre a query da BO conforme os campos e faixas passados na procedure setConstraintFiltro.

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.

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.

Requisito

A setConstraintMaterial ter sido executada anteriormente.

Sintaxe

run openQueryMaterial in h-handle.

Descrição

Abre a query da BO conforme os campos e faixas passados na procedure setConstraintMaterial.

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.

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.

Requisito

Nenhum.

Sintaxe

run validaEvento in this-procedure (input <character>,

                                    input <character>).

Descrição

Valida se o evento informado é de um grupo de evento Óleo (1) ou Filtro (2).

Se não for, cria erro e retorna “NOK”.

Parâmetros

Descrição

pComp

Código do Compartimento

pEvento

Código do Evento

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.

RowErrors.

Requisito

Nenhum.

Sintaxe

run validaItem in this-procedure (input <integer>,

                                  input <character>,

                                  input <character>,

                                  input <character>).

Descrição

Valida se item informado está relacionado a um Tipo de Material e se este tipo de material está associado aos compartimentos do equipamento.

Parâmetros

Descrição

pEmpresa

Código da Empresa

pEqpto

Código do Equipamento

pComp

Código do Compartimento

pItem

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.

Requisito

Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.

Sintaxe

run afterCreateRecord in h-handle.

Descrição

Override após criação do registro.

Parâmetros

Descrição

Nenhum

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

Requisito

Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.

Sintaxe

run afterUpdateRecord in h-handle.

Descrição

Override após alteração do registro.

Parâmetros

Descrição

Nenhum

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

Requisito

Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.

Sintaxe

run afterDeleteRecord in this-procedure.

Descrição

Executa a procedure eliminaRemonta, para excluir os movimentos de remonta gerados pelo apontamento de lubrificação.

Verifica se o movimento de lubrificação eliminado, está integrado com estoque.

Se estiver integrado, será gerado um movimento de Devolução dos materiais na CPAPI001 (API de estoque).

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

Requisito

Procedure chamada pelo método interno deleteRecord. Não deve ser chamada externamente.

Sintaxe

run beforeDeleteRecord in h-handle.

Descrição

Realiza override antes de eleminar algum registro.

Parâmetros

Descrição

Nenhum

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

...

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 a capacidade de armazenamento no tanque e o tipo de material.

Parâmetros

Descrição

pEmpresa

Código da Empresa

pEqpto

Código do Equipamento

pComp

Código do Compartimento

pItem

Código do Item de Estoque

pTipo

Código do Tipo de Material

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

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

Requisito

Nenhum

Sintaxe

run buscaTabela in h-handle (input <integer>).

Descrição

Busca pela tabela mab-abastec-lubrific através do número do documento.

Parâmetros

Descrição

pnum-docto

Número 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 tt-erro....

Requisito

Procedure chamada pelo método afterDeleteRecord. Não deve ser chamada externamente.

Sintaxe

run eliminaRemonta in this-procedure.

Descrição

Elimina histórico da remonta chamado após a eliminação do apontamento de 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....

Requisito

Nenhum.

Sintaxe

run criaFichaAmostraOleo 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....

...

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

Requisito

Nenhum.

Sintaxe

run atualizaDados in this-procedure.

Descrição

Parâmetros

Descrição

pNumDocto 

Número Documento

pCodAmostra

Código Amostra

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

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).

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.