Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr019 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mab-param”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-param”.
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run frbo\bofr019.p.
A execução na forma persistente ...
A sintaxe para executar a BO em modo persistente é:
run frbo\bofr019.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-param”. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cdn-param | int | >>>>9 | Código - Numérico Parâmetro | Sim |
|
des-param | char | x(100) | Descrição do Parâmetro | Sim |
|
des-label-param | char | x(35) | Label | Sim |
|
des-valor | char | x(20) | Valor do Parâmetro | 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 |
|
|
num-max-eqpto | Integer | >>>,>>>,>>9 | Número Máximo Equipamentos Controlados no Sistema |
|
|
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 |
|
Tabela Temporária | Descrição | Entrada/Saída |
ttParamFrotas | Temp-table dos parâmetros de Frotas cadastrados |
|
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codModulo | Char | Padrão | Código do Módulo | Não |
|
cdnParam | integer | Padrão | Código do Parâmetro | Não |
|
desLabelParam | Char | Padrão | Label do Parâmetro | Não |
|
desValorToVisualization | Char | Padrão | Valor do Parâmetro | Não |
|
desParam | Char | Padrão | Descrição do Parâmetro | Não |
|
desValor | Char | padrão | Valor do Parâmetro | Não |
|
Tabela Temporária | Descrição | Entrada/Saída |
ttModulosMD | Temp-table dos Módulos de Frotas Implantados |
|
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codModulo | Integer | Padrão | Código do Módulo | Não |
|
cdFuncao | Char | Padrão | Código da Função | Não |
|
desModulo | Char | Padrão | Descrição do Módulo | Não |
|
logAtivo | Logical | Padrão | Status (Ativo ou Inativo) | Não |
|
logAtivoToVisualization | Char | padrão | Status (Ativo ou Inativo) | 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 <integer>). | |
Descrição | Reposiciona o registro do tabela parâmetros de frota através do código do parâmetro. | |
| Parâmetros | Descrição |
| cdn-param | Código - Numérico Parâmetro |
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>). | |
Descrição | Retorna os campos da chave primária da tabela. | |
| Parâmetros | Descrição |
| cdn-param | Código - Numérico Parâmetro |
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
openQueryMain
Requisito | Nenhum. | |
Sintaxe | run openQueryMain in h-handle. | |
Descrição | Busca conjunto de registros da tabela mab-param. Os registros são ordenados pelo código do parâmetro. | |
| 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. |
atualizaValor1
Requisito | Nenhum | |
Sintaxe | run atualizaValor1 in hDBOParam (input <integer>, input <character>, input <character>, input-output <character>). | |
Descrição | Recebe o código, o valor de label, a descrição do parâmetro e o valor do parâmetro para realizar a validação contra outras tabelas do sistema se existe o tipo de parâmetro informado. Se o parâmetro não existe cria o parâmetro e atualiza estes campos da tabela com os valores informados. Este método é utilizado quando o valor do parâmetro for do tipo caracter. | |
| Parâmetros | Descrição |
| pCod | Código do parâmetro |
pLabel | Label | |
pDes | Descrição do Parâmetro | |
pValor | Valor do parâmetro | |
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.... |
atualizaValor2
Requisito | Nenhum | |
Sintaxe | run atualizaValor2 in hDBOParam (input <integer>, input <character>, input <character>, input-output <character>). | |
Descrição | Recebe o código, o valor de label, a descrição do parâmetro e o valor do parâmetro para realizar a validação contra outras tabelas do sistema se existe o tipo de parâmetro informado. Se o parâmetro não existe cria o parâmetro e atualiza estes campos da tabela com os valores informados. Este método é utilizado quando o valor do parâmetro for do tipo obtido da definição de uma include padrão. | |
| Parâmetros | Descrição |
| pCod | Código do parâmetro |
pLabel | Label | |
pDes | Descrição do Parâmetro | |
pValor | Valor do parâmetro | |
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.... |
atualizaValor3
Requisito | Nenhum | |
Sintaxe | run atualizaValor3 in hDBOParam (input <integer>, input <character>, input <character>, input-output <character>). | |
Descrição | Recebe o código, o valor de label, a descrição do parâmetro e o valor do parâmetro para realizar a validação contra outras tabelas do sistema se existe o tipo de parâmetro informado. Se o parâmetro não existe cria o parâmetro e atualiza estes campos da tabela com os valores informados. Este método é utilizado quando o valor do parâmetro for do tipo decimal. | |
| Parâmetros | Descrição |
| pCod | Código do parâmetro |
pLabel | Label | |
pDes | Descrição do Parâmetro | |
pValor | Valor do parâmetro | |
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.... |
validaParametros
Requisito | Nenhum | |
Sintaxe | run validaParametros in this-procedure (input <integer>, input <character>). | |
Descrição | Recebe o código e o valor do parâmetro para realizar a validação contra outras tabelas do sistema se existe o tipo de parâmetro informado. | |
| Parâmetros | Descrição |
| pParam | Código do parâmetro |
pValor | Valor do parâmetro | |
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.... |
loadParamsMetadados
Requisito | Nenhum | |
Sintaxe | run loadParamsMetadados in hDBOParam (output <temp-table>, output <temp-table>, output <character>). | |
Descrição | Retorna os registros existentes dos parâmetros de frotas e dos módulos de frotas implantados, assim como a quantidade de equipamentos cadastrados. | |
| Parâmetros | Descrição |
| ttParamFrotas | Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento) |
ttModulosMD | Temp-table dos Módulos de Frotas Implantados (Ver definição de Temp-table no início desse documento) | |
cNrEqptoRela | Numero de Equipamentos Cadastrados | |
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. |
getFieldType
Requisito | Nenhum | |
Sintaxe | run getFieldType in hDBOParam (input <integer>, output <integer>. | |
Descrição | Retorna o tipo do parâmetro, pode esse ser: “1-Decimal”, “2-Valores em combo Box”, “3-Inteiro”, “4-Character”, “5-Zoom UM”, “6-Zoom Eventos”, “7-Zoom de sub-sistema”, “8-Zoom de Tipo Manutenção”, “9-Zoom Tipo Empresa”, “10-Zoom de Motorista”, “11-Zoom de Tipo Trajeto Padrão”, “12-Zoom de Causa Padrão”, “13-Zoom Catálogo Documento Características Componente, “14-check Box”. | |
| Parâmetros | Descrição |
| pCdnParam | Código do Parâmetro |
fieldType | Tipo do Parâmetro | |
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. |
atualizaValorMetadados
Requisito | Nenhum | |
Sintaxe | run atualizaValorMetadados in hDBOParam (input <temp-table>, output <temp-table>, output <temp-table>). | |
Descrição | Realiza as atualizações dos Parâmetros de Frotas alterados via Metadados. | |
| Parâmetros | Descrição |
| ttParamFrotas | Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento) |
ttParamFrotas | Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse documento) | |
rowErrors | Temp-table de Erros (Ver definição de Temp-table no início desse 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.
|
getDadosMotoristaPadraoMD
Requisito | Nenhum | |
Sintaxe | run getDadosMotoristaPadraoMD in hDBOParam (input <character>, output <character>, output <character>, output <character>). | |
Descrição | Retorna informações do motorista padrão. | |
| Parâmetros | Descrição |
| pdesValor | Valor do Parâmetro |
pEmp | Código da Empresa | |
pEstab | Código do Estabelecimento | |
pMoto | Código do Motorista | |
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.
|
updateModulosMetadados
Requisito | Nenhum | |
Sintaxe | run updateModulosMetadados in hDBOParam (input <integer>, input <logical>, output <temp-table>). | |
Descrição | Altera e Retorna os Módulos de Frotas. | |
| Parâmetros | Descrição |
| pModulo | Código do Módulo |
pAtivo | Status (Ativo ou Inativo) | |
ttModulosMD | Temp-table dos parâmetros de Frotas cadastrados (Ver definição de Temp-table no início desse 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. |
getParamsFiltered
Requisito | Nenhum | |
Sintaxe | run getParamsFiltered in hDBOParam (input <character>, output <temp-table>). | |
Descrição | Retorna os Parâmetros de Frotas filtrados conforme Filtro recebimento por parâmetro. | |
| Parâmetros | Descrição |
| pParam | Parâmetro referente ao Filtro |
ttParamFrotas | Temp-table dos parâmetros de Frotas cadastrados (conforme Filtro) (Ver definição de Temp-table no início desse 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. |