Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr059 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mab-movto-event”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-movto-event”.
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run frbo\bofr059.p.
A execução na forma persistente ...
A sintaxe para executar a BO em modo persistente é:
run frbo\bofr059.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-movto-event”. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num-docto | int | >>>,>>>,>>9 | Indica o documento relacionado ao evento apontado para equipament | Sim / Key | 001 |
dat-inicial | Date | 99/99/9999 | Data de Abertura do apontamento do evento | Sim | 001 |
hra-incial | Char | 99:99:99 | Hora Inicial | Sim | 001 |
dta-aviso | Date | 99/99/9999 | Data de Aviso | Sim | 001 |
val-km-aviso | Decimal | >>,>>>,>>9 | Aviso para chamada do evento | Não | 001 |
ep-codigo | Int | >>9 | Código da empresa do equipamento | Sim | 001 |
cod-eqpto | Char | X(16) | Código do Equipamento | Sim | 001 |
cod-evento | Char | X(08) | Códgio do Evento | Sim | 001 |
val-evento | Decimal | >>,>>>,>>9.99 | Valor Evento | Não | 001 |
cd-tipo | Int | >>,>>9 | Código do Tipo de Manutenção | Não | 001 |
cod-sub-sist | Char | X(8) | Código Sub-Sistema | Não | 001 |
num-doc-original | Int | >>>,>>>,>>9 | Número do documento origem | Não | 001 |
dat-final | Date | 99/99/9999 | Data de encerramento do evento | Não | 001 |
hra-final | Char | 99:99:99 | Hora Final | Não | 001 |
log-disparad | Log | Sim/Não | Disparado | Não | 001 |
dsl-obs | Char | X(800) | Observação | Não | 001 |
cod-usuar | Char | X(12) | Usuário | Não | 001 |
cod-ofici | Char | X(8) | Código da Oficina | Não | 001 |
cod-matr | Char | X(10) | Código Motorista | 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 |
num-parc-event | Int | >>9 | Número da Parcela da Programação de Eventos | Não |
|
ct-despesa | char | x(20) | Conta para lançamentos de despesas dos eventos dos equipamentos | Não |
|
cc-despesa | Char | x(20) | Centro Custo Despesa | Não |
|
cod-emitente | int | >>>>>>>>9 | Código do emitente do documento | Não |
|
ep-codigo-matr | int | >>9 | Empresa do Motorista | Não |
|
cod-estabel-matr | char | x(3) | Estabelecimento do Motorista | Não |
|
num-docto-proces | int | >>>.>>>.>>9 | Número do Documento do Processo | Não | 001 |
Tabela Temporária | Descrição | Entrada/Saída |
RowErrors e RowErrorsAux | 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>). | |
Descrição | Reposiciona a query com base na chave primária da tabela. | |
| Parâmetros | Descrição |
| pnum-docto | Valor do Campo 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. |
getKey
Requisito | Nenhum | |
Sintaxe | run getKey in h-handle (output <integer>, output <character>). | |
Descrição | Retorna os campos da chave primária da tabela. | |
| Parâmetros | Descrição |
| pnum-docto | Valor do Campo 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. |
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. |
OpenQuery / SetConstraint / LinkTo
setConstraintData
Requisito | Nenhum | |
Sintaxe | run setConstraintData in h-handle (input <date>, input <date>, input <logical>, input <logical>). | |
Descrição | Seta as restrições para abrir a query por faixa de data. | |
| Parâmetros | Descrição |
| pDataIni | Data Inicial |
| pDataFim | Data Final |
| pNExecutados | Log de Eventos não Executados |
| pExecutados | Log de Enventos Executados |
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 <character>, input <character>, input <logical>, input <logical>). | |
Descrição | Seta as restrições para abrir a query por faixa do número do documento. | |
| Parâmetros | Descrição |
| pDocIni | Código Documento Inicial |
| pDocFim | Código Documento Final |
| pNExecutados | Log de Eventos não Executados |
| pExecutados | Log de Enventos Executados |
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. |
setConstraintEqpto
Requisito | Nenhum | |
Sintaxe | run setConstraintEqpto in h-handle (input <integer>, input <character>, input <logical>, input <logical>). | |
Descrição | Seta as restrições para abrir a query por faixa Cód. Empresa e Cód Equipamento. | |
| Parâmetros | Descrição |
| pEmpIni | Código Empresa Inicial |
| pEmpFim | Código Empresa Final |
| pEqptoIni | Código Equipamento Inicial |
| pEqptoFim | Código Equipamento Final |
| pNExecutados | Log de Eventos não Executados |
| pExecutados | Log de Enventos Executados |
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. |
openQueryData
Requisito | A setConstraintData ter sido executada anteriormente. | |
Sintaxe | run openQueryData in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de datas passada na procedure setConstraintData. | |
| 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. |
openQueryDocumento
Requisito | A setConstraintDocumento ter sido executada anteriormente. | |
Sintaxe | run openQueryDocumento in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de Código Documento passada 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. |
openQueryEqpto
Requisito | A setConstraintEqpto ter sido executada anteriormente. | |
Sintaxe | run openQueryEqpto in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de Código da Empresa e Código do Equipamento passados na procedure setConstraintEqpto. | |
| 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. |
validateData
Requisito | Ter sido executada alguma ação para manutençaõ do registro da tabela. Esta procedure é executada somente internamente pela BO. | |
Sintaxe | run validateData in this-procedure. | |
Descrição | Verifica se as datas foram informadas corretamente. | |
| 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.... |
buscaDocumento
Requisito | Nenhum | |
Sintaxe | run buscadocumento in h-handle (output <integer>). | |
Descrição | Realiza busca automatica pela númeração do proximo registro. | |
| Parâmetros | Descrição |
| pNrDoc | Código 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 tt-erro.... |
consisteInclusaoDocto
Requisit | Nenhum | |
Sintaxe | run consisteInclusaoDocto in h-handle (input <integer>, input <character>, input <character>, input <character>, input <integer>). | |
Descrição | Verifica se existe documento para equipamento, com evento informado.
| |
| Parâmetros | Descrição |
| pEmp | Código da Empresa |
| pEqpto | Código do Equipamento |
| pEvento | Código do Envento |
| pSubSist | Código do SubSistema |
| pDoc | Código 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 tt-erro.... |
consisteResgistro
Requisito | Nenhum. | |
Sintaxe | run consisteResgistro in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <date>). | |
Descrição | Verifica se existe documento para equipamento, com evento informado. | |
| Parâmetros | Descrição |
| pNrnum-docto | Código do Documento |
| pCodEmpresa | Código da Empresa |
| pCodEqpto | Códgio do Equipamento |
| pCodEvento | Código do Evento |
| pData | Data 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 tt-erro.... |
criaEvento
Requisito | Nenhum. | |
Sintaxe | run criaEvento in h-handle (input <RowObject>). | |
Descrição | Cria um evento chamado pelas APIs de abastecimento
| |
| Parâmetros | Descrição |
| RowObject | Temp-Table principal 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 tt-erro.... |
criaMovEvento
Requisito | Nenhum. | |
Sintaxe | RUN criaMovEvento IN THIS-PROCEDURE. | |
Descrição | Cria Evento em tabela passando pelas validações.
| |
| 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). |
criaMovimento
Requisito | Nenhum. | |
Sintaxe | RUN criaMovimento IN h-handle (input <integer>, input <character>, input <date>, input <character>, input <character>, input <character>, input <integer>, input <date>, input <character>, input <integer>, input <date>, input <character>, output <ttMovEnveto>, output <integer>). | |
Descrição | Cria o movimento para o evento informado | |
| Parâmetros | Descrição |
| pEmp | Código da Empresa |
| pEqpto | Código do Equipamento |
| pDtAtual | Data Atual |
| pHoraAtual | Hora Atual |
| pSubSist | Código do SubSistema |
| pCodEvento | Código do Evento |
| pHras-Km | Aviso para chamada do Envento |
| pDtAntecip | Dias de Antecipação |
| pCodOfic | Código da Oficina |
| pTpParam | Tipo de Parâmentro |
| pDtExec | Data de Execusão |
| pHoraExec | Hora de Execusão |
| ttMovEvento | Temp-Table principal da BO |
| iDoc | Código 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). |
setaPrograma
Requisito | Nenhum. | |
Sintaxe | RUN setaPrograma IN h-handle (input <character>) . | |
Descrição | Define o nome do programa que irá executar a BO.
| |
| Parâmetros | Descrição |
| pPrograma | Nome 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). |
afterUpdateRecord
Requisito | Procedure para uso interno. | |
Sintaxe | RUN afterUpdateRecord IN h-handle. | |
Descrição | Verifica se a data final é valida e executa a procedure “criaHistEvento”, existente nesta mesma BO.
| |
| 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). |
criaEventoProcesso
Requisito | Executada a partir da API de Geração de Eventos Programados “ndapi003”. | |
Sintaxe | RUN criaEventoProcesso IN h-handle (input <temp-table>). | |
Descrição | Cria eventos com base nas informações geradas pela api de documentos “ndapi003”
| |
| Parâmetros | Descrição |
| RowObject | Tabela temporária referente a tabela de movimentos de eventos “mab-movto-event” |
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). |
criaHistEvento
Requisito | Procedure para uso interno. | |
Sintaxe | RUN criaHistEvento IN h-handle (input <integer>, input <integer>, input <integer>). | |
Descrição | Através dos Parâmetros recebidos é executado a procedure “criaHist” na bofr118, onde literalmente é criado os devidos históricos
| |
| Parâmetros | Descrição |
| pNrDocto | Número do Documento do Processo |
| pActionHist | Ação a ser executada (1-Cria 2-Altera 3-Deleta Parcelas 4-Cancela Documentos) |
| pNrDoctoEvent | Número do Documento 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). |
linkToEvento
Requisito | Procedure para uso interno. | |
Sintaxe | {masterdetail/openqueriesson.i &Parent="Evento" &Query="Evento" &PageNumber="2"} Obs.: Utilizado na abertura de query | |
Descrição | Utilizada para busca de relacionamento de registro Pai/Filho.
| |
| Parâmetros | Descrição |
| pHandle | Handle |
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). |
openQueryEvento
Requisito | A setConstraintEvento ter sido executada anteriormente. | |
Sintaxe | run openQueryEvento in h-handle. | |
Descrição | Abre a query da BO conforme o número de documento passado na procedure setConstraintEvento | |
| 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. |
removeEventosParcelas
Requisito | Nenhum | |
Sintaxe | run o removeEventosParcelas in h-handle (input <integer>). | |
Descrição | Remove todas as Parcelas “Movimentos de Eventos” relacionados ao documento de Processo Administrativo. | |
| Parâmetros | Descrição |
| pNumDocto | Número do Documento do Processo Administrativo |
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. |
setConstraintEvento
Requisito | Nenhum | |
Sintaxe | run o setConstraintEvento in h-handle (input <integer>). | |
Descrição | Seta as restrições para abrir a query por faixa do Número do Documento. | |
| Parâmetros | Descrição |
| pNumDocto | Número do Documento do Processo Administrativo |
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. |
terminaEventosParcelas
Requisito | A openQueryMain ter sido executada anteriormente. | |
Sintaxe | run o terminaEventosParcelas in h-handle (input <integer>, input <date>, input <character>). | |
Descrição | Realiza o término de todas as Parcelas “Movimentos de Eventos” relacionados ao documento de Processo Administrativo. | |
| Parâmetros | Descrição |
| pNumDocto | Número do Documento do Processo Administrativo |
| pDateFinal | Data de término da Parcela “Movimentos de Eventos” |
| pHorFinal | Hora de término da Parcela “Movimentos de Eventos” |
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. |