Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr004 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mab-comptmento-eqpto”.
...
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:
...
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ep-codigo | int | >>9 | Empresa Equipamento | Sim / Key | 001 |
cod-eqpto | char | x(16) | Código Equipamento | Sim / Key | 001 |
cod-comptmento | char | x(8) | Código Compartimento | Sim / Key | 001 |
cod-tip-mater | char | x(8) | Código Tipo Material | Sim | 001 |
qtd-capac | dec | >>>>9.99 | Capacidade Compartimento | Sim | 001 |
val-km-inicial | dec | >>,>>>,>>9.9 | Uso Inicial | Não | 001 |
idi-remonta | int | 9 | Remonta 1 = Normal 2 = Anormal | Sim | 001 |
cod-sub-sist | char | x(8) | Código Sub Sistema | Sim | 001 |
val-perc-remon | dec | >>9.99 | % Remonta | Sim | 001 |
cod-livre-1 | char | x(100) | Character Livre | Não | 001 |
cod-livre-2 | char | x(100) | 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 |
...
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 API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
...
Requisito | A setConstraintCompartimento e a setConstraintEquipamento ou setConstraintRowEquipamento terem sido executadas anteriormente. | |||
Sintaxe | run openQueryCompartimentoEqpto in h-handle. | |||
Descrição | Abre a query da BO conforme a faixa de Código do Compartimento passada na procedure setConstraintCompartimento e conforme o equipamento setado em umas das procedures setConstraintEquipamento ou setConstraintRowEquipamento. | |||
| 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 | setConstraintCompartimento e a setConstraintEquipamento ou setConstraintRowEquipamento | terem ter sido | executadas executada anteriormente. | ||||
Sintaxe | run | openQueryComptoEqpto openQueryEquipamento in h-handle. | ||||||
Descrição | Abre a query da BO | conforme a faixa de Código do Compartimento do Equipamento passada na procedure setConstraintCompartimento e conforme o equipamento setado em umas das procedures setConstraintEquipamento ou setConstraintRowEquipamento. | ||||||
| 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 | A setConstraintEquipamento ou setConstraintRowEquipamento ter sido executada anteriormente.Nenhum | |
Sintaxe | run openQueryEquipamento in h-handle. | |
Descrição | Abre a query da BO conforme o equipamento setado em umas das procedures setConstraintEquipamento ou setConstraintRowEquipamento. | |
| 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 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. |
...
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. |
...
buscaCamposCompartimento
Requisito | Nenhum | |
Sintaxe | run buscaCamposCompartimento in h-handle (input <character>, output <integer>, output <logical>). | |
Descrição | Busca os dados do compartimento passado para validações. | |
| Parâmetros | Descrição |
| pComp | Código do Compartimento |
| pTipo | Tipo de Compartimento 1 = Óleo 2 = Filtro |
| pMotor | Compartimento do Motor? |
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.... |
...