Histórico da Página
Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr058 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mab-item-lubrific”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-item-lubrific”.
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run frbo\bofr058.p.
A execução na forma persistente ...
A sintaxe para executar a BO em modo persistente é:
run frbo\bofr058.p persistent set h-handle.
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 |
RowObject | Tabela de comunicação entre Interface e banco de dados da tabela “mab-item-lubrific”. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num-docto | int | >>>,>>>,>>9 | Número Documento | Sim / Key | 001 |
cod-comptmento | char | x(8) | Código do Compartimento | Sim / Key | 001 |
it-codigo | char | x(16) | Código do Item de Estoque | Sim / Key | 001 |
cod-evento | char | x(8) | Código do Evento | Sim | 001 |
cd-tipo | int | >>,>>9 | Código do Tipo de Manutenção | Sim | 001 |
val-quant | dec | >>>,>>9.99 | Quantidade Lubrificada | Sim | 001 |
val-mater-1 | dec | >>>,>>>,>>9.999 | Valor do abastecimento na moeda 0. | Não | 001 |
val-mater-2 | dec | >>>,>>>,>>9.999 | Valor do abastecimento na moeda 1. | Não | 001 |
val-mater-3 | dec | >>>,>>>,>>9.999 | Valor do abastecimento na moeda 2. | Não | 001 |
ep-codigo | int | >>9 | Empresa Equipamento | Sim | 001 |
cod-eqpto | char | x(16) | Código Equipamento | Sim | 001 |
val-dat-hora-invrtda | dec | 999999999999 | Valor da Data e Hora Invertidas do Apontamento | Sim | 001 |
cod-tip-mater | char | x(16) | Código do Tipo de Material | Sim | 001 |
cod-refer | char | x(8) | Referência do Item de Estoque | Não | 001 |
cod-localiz | char | x(10) | Localização do Item de Estoque | Não | 001 |
lote | char | x(10) | Lote do Item de Estoque | Não | 001 |
nr-trans | int | >>>,>>>,>>9 | Número da transação ocorrida no estoque (CEAPI001). | Não | 001 |
cod-livre-1 | char | x(1000) | Character Livre | Não | 001 |
cod-livre-2 | char | x(1000) | Character Livre | Não | 001 |
log-livre-1 | log | Sim/Não | Logical Livre | Não | 001 |
log-livre-2 | log | Sim/Não | Logical Livre | Não | 001 |
num-livre-1 | int | ->>>>>>>>>9 | Inteiro Livre | Não | 001 |
num-livre-2 | int | ->>>>>>>>>9 | Inteiro Livre | Não | 001 |
val-livre-1 | dec | ->>>>>>>>>>>9.9 | Decimal Livre | Não | 001 |
val-livre-2 | dec | ->>>>>>>>>>>9.9 | Decimal Livre | Não | 001 |
dat-livre-1 | date | 99/99/9999 | Data livre | Não | 001 |
dat-livre-2 | date | 99/99/9999 | Data livre | Não | 001 |
log-gera-amostra-oleo | Log | Sim/Não | Gera Amostra Óleo | Não | 001 |
cod-amostra-fisic | Char | x(12) | Número / Código da Amostra Física do Óleo | Não | 001 |
cod-causa | char | x(8) | Causa | Não | 001 |
cod-estabel | char | x(5) | Código do Estabelecimento | Não | 001 |
cod-cta-ctbl | char | x(20) | Código da Conta Contábil Lubrificação | Não | 001 |
cod-ccusto | char | x(20) | Código do Centro de Custo Lubrificação | Não | 001 |
Tabela Temporária | Descrição | Entrada/Saída |
RowErrors | Contém os erros ocorridos na BO. | Saída |
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étodos
Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Básico
goToKey
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. |
getKey
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. |
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 / SetConstraint / LinkTo
linkToAmostra
Requisito |
| |
Sintaxe | run linkToAmostra in h-handle (input <hanlde>). | |
Descrição |
| |
| Parâmetros | Descrição |
| pHandle | Handle da BO. |
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. |
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-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. |
setConstraintAmostra
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. |
setConstraintEquipamento
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. |
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. |
setConstraintFiltro
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. |
setConstraintDocumento
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. |
setConstraintMaterial
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. |
openQueryAmostra
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. |
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. |
openQueryDocumento
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. |
openQueryEquipamento
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. |
openQueryFiltro
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. |
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. |
openQueryMaterial
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. |
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 | 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. |
validaEvento
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. |
validaItem
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. |
afterCreateRecord
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.... |
afterUpdateRecord
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.... |
afterDeleteRecord
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.... |
beforeDeleteRecord
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.... |
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 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.... |
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.... |
buscaTabela
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.... |
eliminaRemonta
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.... |
criaFichaAmostraOleo
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.... |
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.... |
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.... |
atualizaDados
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.... |
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). |
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. |
inicializaHandle
Requisito | Nenhum | |
Sintaxe | run inicializaHandle in h-handle. | |
Descrição | Inicialização de handle para chamada a partir do programa ab0705 Obs.: Uso Interno. | |
| 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. |
finalizaHandle
Requisito | Nenhum | |
Sintaxe | run finalizaHandle in h-handle. | |
Descrição | Finalização de handle para chamada a partir do programa ab0705 Obs.: Uso Interno. | |
| 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. |