Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr006 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mab-consu-model”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-consu-model”.
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run frbo\bofr006.p.
A execução na forma persistente ...
A sintaxe para executar a BO em modo persistente é:
run frbo\bofr006.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-consu-model”. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | ||
cod-model | Char | X(8) | Código do Modelo | Sim |
| ||
cod-ativid | char | X(8) | Código da atividade | Sim |
| ||
cod-tip-mater | Char | X(8) | Código do tipo de material | Sim |
| ||
val-consu-padr | Dec | >>>>>9.99 | Consumo padrão | Sim |
| ||
cod-livre-1 | char | X(100) | Livre 1 |
|
| ||
cod-livre-2 | char | X(100) | Livre 2 |
|
| ||
log-livre-1 | Log | Sim/Não | Livre 1 |
|
| ||
log-livre-2 | Log | Sim/Não | Livre 2 |
|
| ||
num-livre-1 | Int | ->>>>>>>>>9 | Livre 1 |
|
| ||
num-livre-2 | Int | ->>>>>>>>>9 | Livre 2 |
|
| ||
val-livre-1 | Dec | ->>>>>>>>>>>9.9999 | Livre 1 |
|
| ||
val-livre-2 | Dec | ->>>>>>>>>>>9.9999 | Livre 2 |
|
| ||
dat-livre-1 | date | 99/99/9999 | Livre 1 |
|
| ||
dat-livre-2 | date | 99/99/9999 | Livre 2 |
|
| ||
val-consu-sec | Dec | >>>,>>9.99 | Consumo Secundário |
|
| ||
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>, input <character>, input <character>). | ||
Descrição | Reposiciona o registro da configuração do eixo através do código do modelo, código da atividade e o código do tipo de material. | ||
| Parâmetros | Descrição | |
| cod-model | Código do modelo | |
| cod-ativid | Código da atividade | |
| cod-tip-mater | Código do tipo de material | |
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>, output <character>, output <character>). | ||
Descrição | Retorna os campos da chave primária da tabela. | ||
| Parâmetros | Descrição | |
| cod-model | Código do modelo | |
| cod-ativid | Código da atividade | |
| cod-tip-mater | Código do tipo de material | |
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
linkToMfo-Modelo
Requisito | Posicionar a query do BO de mab-model no registro desejado. | |
Sintaxe | run linkToMfo-Modelo in h-handle (input <hanlde>). | |
Descrição | Seta as variáveis de controle para criar o linkTo com a tabela pai “mab-model” contendo o campo cod-model. | |
| Parâmetros | Descrição |
| pHandle | Handle BO da tabela mab-model |
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. |
setConstraintCodAtiv
Requisito | Nenhum | |
Sintaxe | run setConstraintCodAtiv in h-handle (input <character>, input <character>). | |
Descrição | Carrega as variável com uma faixa inicial e final do código da atividade para openQueryCodAtiv. | |
| Parâmetros | Descrição |
| pCdAtivIni | Código da atividade inicial |
| pCdAtivFim | Código da atividade 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. |
setConstraintCodMatl
Requisito | Nenhum | |
Sintaxe | run setConstraintCodMatl in h-handle (input <character>, input <character>). | |
Descrição | Carrega as variável com uma faixa inicial e final do código do material para openQueryCodMatl. | |
| Parâmetros | Descrição |
| pCdTpMtIni | Código do material inicial |
| pCdTpMtFim | Código do material 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. |
setConstraintCodModelo
Requisito | Nenhum | |
Sintaxe | run setConstraintCodModelo in h-handle (input <character>, input <character>). | |
Descrição | Carrega as variável com uma faixa inicial e final do código do modelo para openQueryCodModelo. | |
| Parâmetros | Descrição |
| pCdModeloIni | Código do modelo inicial |
pCdModeloFim | Código do modelo 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. |
setConstraintMfo-Model
Requisito | Nenhum | |
Sintaxe | run setConstraintMfo-Model in h-handle input <character>). | |
Descrição | Carrega a variável do código do modelo para openQueryMfo-Model. | |
| Parâmetros | Descrição |
| pCodModelo | Código do modelo |
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. |
openQueryCodMatl
Requisito | Executar o método setConstraintCodMatl. |
Sintaxe | run openQueryCodMatl in h-handle. |
Descrição | Busca conjunto de registros da tabela mab-consu-model com base em uma faixa do código do tipo de material. Os registros são ordenados pelo código do tipo de material.
|
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 | Busca conjunto de registros da tabela mab-consu-model. Os registros são ordenados pelo código do modelo, código da atividade e o código do tipo de material. | |
| 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. |
openQueryCodModelo
Requisito | Executar os métodos setConstraintCodModelo. |
Sintaxe | run openQueryCodModelo in h-handle. |
Descrição | Busca conjunto de registros da tabela mab-consu-model com base em uma faixa do código do modelo. Os registros são ordenados pelo código do modelo.
|
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. |
|
|
openQueryMfo-Modelo
Requisito | Executar os métodos setConstraintMfo-modelo. |
Sintaxe | run openQueryMfo-Modelo in h-handle. |
Descrição | Busca conjunto de registros da tabela mfo-modelo com base mas variaveis do método likToMfo-model. Os registros são ordenados pelo código do modelo.
|
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. |
openQueryCodAtiv
Requisito | Executar os métodos setConstraintCodAtiv. |
Sintaxe | run openQueryCodAtiv in h-handle. |
Descrição | Busca conjunto de registros da tabela mab-consu-model com base em uma faixa da atividade. Os registros são ordenados pelo código da atividade.
|
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. |