Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi598.p |
Objetivo
Criação, Validação, Manutenção e acesso rápido a tabela “val-ctbl-ifrs”
Funcionamento
A BO irá criar, validar os dados, manutenir as tabelas e fazer a leitura dos registros da tabela “val-ctbl-ifrs”
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run dibo\bodi598.p.
A execução na forma persistente ...
A sintaxe para executar a BO em modo persistente é:
run dibo\bodi598.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 “val-ctbl-ifrs”. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | ||
cod-estab | char | x(03) | Estabelecimento | Sim |
| ||
cod-serie | char | X(05) | Série Documento | Sim |
| ||
cod-nota-fisc | char | X(16) | Número Documento | Sim |
| ||
val-ctbl-docto | dec | ->>,>>>,>>>,>>9.99 | Valor Contábil | Sim |
| ||
val-entreg | char | >>>,>>>,>>9.99 | Valor Entrega | Sim |
| ||
val-provis | date | ->>>>>,>>9.99 | Valor Provisão | Sim |
| ||
cod-livre-1 | char | X(100) | Livre 1 | Não |
| ||
cod-livre-2 | char | X(100) | Livre 2 | Não |
| ||
log-livre-1 | Log | Sim/Não | Livre 1 | Não |
| ||
log-livre-2 | Log | Sim/Não | Livre 2 | Não |
| ||
num-livre-1 | Int | ->>>>>>>>>9 | Livre 1 | Não |
| ||
num-livre-2 | Int | ->>>>>>>>>9 | Livre 2 | Não |
| ||
val-livre-1 | Dec | ->>>>>>>>>>>9.9999 | Livre 1 | Não |
| ||
val-livre-2 | Dec | ->>>>>>>>>>>9.9999 | Livre 2 | Não |
| ||
dat-livre-1 | date | 99/99/9999 | Livre 1 | Não |
| ||
dat-livre-2 | date | 99/99/9999 | Livre 2 | Não |
| ||
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 |
|
ErrorNumber | integer | padrão | Número do erro | Sim |
|
ErrorDescription | char | padrão | Descrição do erro | Sim |
|
ErrorParameters | char | padrão | Parâmetros passados para criar mensagem | Não |
|
ErrorType | char | padrão | Tipo do erro: WARNING: Aviso ERROR: Erro | Sim |
|
ErrorHelp | char | padrão | Texto de ajuda do erro | Sim |
|
ErrorSubType | char | padrão | Sub Tipo da mensagem de erro | Não |
|
Métodos
Quando a API/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 <character>). | |
Descrição | Reposiciona a query com base na chave primária da tabela. DEFINE INPUT PARAMETER pcod-estab LIKE val-ctbl-ifrs.cod-estab NO-UNDO. DEFINE INPUT PARAMETER pcod-serie LIKE val-ctbl-ifrs.cod-serie NO-UNDO. DEFINE INPUT PARAMETER pcod-nota-fisc LIKE val-ctbl-ifrs.cod-nota-fisc NO-UNDO. | |
| Parâmetros | Descrição |
| pcod-estab pcod-serie pcod-nota-fisc | Código do Estabelecimento Série do Documento 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. |
getKey
Requisito | Nenhum | |
Sintaxe | run getKey in h-handle (output <character>). | |
Descrição | Retorna os campos da chave primária da tabela. | |
| Parâmetros | Descrição |
| pcod-estab pcod-serie pcod-nota-fisc | Código do Estabelecimento Série do Documento 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. |
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
Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura) utilizadas para buscar grupos de registros da base de dados.
setConstraintOfNotaFiscal
Requisito | Nenhum | |
Sintaxe | run setConstraintOfNotaFiscal in h-handle (input <character>, input <character>). | |
Descrição | Carrega variáveis com código da Atividade inicial e final para openQueryOfNotaFiscal. | |
| Parâmetros | Descrição |
| pcod-estab pcod-serie pcod-nota-fis | Código do Estabelecimento Série do Documento 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. |
openQueryStatic(“Main”)
Requisito | Nenhum |
Sintaxe | run openQueryMain in h-handle. |
Descrição | Busca conjunto de registros da tabela Val-ctbl-ifrs. |
openQueryOfNotaFiscal
Requisito | Executar o método setConstraintOfNotaFiscal. |
Sintaxe | run openQueryOfNotaFiscal in h-handle. |
Descrição | Busca conjunto de registros da tabela nota-fiscal. |
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. |