Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr030 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mco-histor-vida”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mco-histor-vida”.
...
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 “mco-histor-vida”. | Entrada/Saída |
...
Método Básico
goToKey
Requisito | Nenhum |
| ||||||
Sintaxe | run goToKey in h-handle (input <integer>, input <integer>). | |||||||
Descrição | Reposiciona a query com base na chave primária da tabela. | |||||||
| Parâmetros | Descrição | ||||||
| pnum-seqcial | Número Sequencial | ||||||
| pnum-vida | Código da Vida | ||||||
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 <integer>). |
| ||||||
Descrição | Retorna os campos da chave primária da tabela. | |||||||
| Parâmetros | Descrição | ||||||
| pnum-seqcial | Número Sequencial | ||||||
| pnum-vida | Código da Vida | ||||||
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 |
getDecField
Nenhum | ||||
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. |
| ||||||
getIntField
Requisito | Nenhum | |||||||
Sintaxe | run getLogField 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. |
| ||||||
geLogField
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
setConstraintMco-compon
Requisito | Nenhum | |||
Sintaxe | run setConstraintMco-compon in h-handle (input <integer>). | |||
Descrição | Seta as restrições para abrir a query de componente. | |||
| Parâmetros | Descrição | ||
| pNumSeqcial | Número Sequencial. | ||
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. |
| ||
openQueryNumSeqcial
Requisito | A setConstraintMco-compon ter sido executada anteriormente. | |||
Sintaxe | run openQueryNumSeqcial in h-handle. | |||
Descrição | Abre a query da BO conforme a faixa de Número Sequencial passada na procedure setConstraintMco-compon. | |||
| 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. | |||
openQueryDefault
Requisito | Nenhum | |
Sintaxe | run openQueryDefault in h-handle. | |
Descrição | Realiza a abertura da query da BO. | |
| Parâmetros | Descrição |
| Não Contem | |
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. | |
...
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. |
| ||
setaPrograma
Requisito | Nenhum | |||
Sintaxe | run setaPrograma in h-handle (input <character>). | |||
Descrição | Seta na BO o programa que está gerando a vida. | |||
|
| Parâmetros | Descrição | |
| pPrograma | Programa que está gerando a vida | ||
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.... |
| ||
LinkTomco-compon
Requisito | Nenhum | |||
Sintaxe | run linkTomco-compon in h-handle (input <handle>). | |||
Descrição | Faz o link entra as tabelas “mco-compon” e “mco-histor-vida”. | |||
|
| Parâmetros | Descrição | |
| pHandle | Handle da BO da tabela mco-compon | ||
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.... |
| ||
atualizaDurabilidade
Requisito | Nenhum. | |||
Sintaxe | run atualizaDurabilidade in this-procedure. | |||
Descrição | Atualiza o total da durabilidade do componente. | |||
| 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.... |
| ||
afterCreateRecord
Requisito | Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente. | |||
Sintaxe | run afterCreateRecord in this-procedure. | |||
Descrição | Atualiza campos internos. | |||
| 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 tt-erro.... |
| ||
afterUpdateRecord
Requisito | Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente. | |||
Sintaxe | run afterUpdateRecord in this-procedure. | |||
Descrição | Atualiza campos internos. | |||
| 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 tt-erro.... | |||
afterDeleteRecord
Requisito | Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente. | |||
Sintaxe | run afterUpdateRecord in this-procedure. | |||
Descrição | Atualiza campos internos. | |||
| 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 tt-erro....
| |||
validaExistenciaHistoricoComponente
Requisito | Nenhum | |
Sintaxe | run validaExistenciaHistoricoComponente in h-handle (input <character>, output <integer>). | |
Descrição | Realiza a validação se ainda é possível incluir históricos para o componente, retornando a ultima vida do componente que tenha a vida maior ou igual a vida inicial. | |
| Parâmetros | Descrição |
| pnumSeqcial | Código Sequencial do Componente |
| piNumVida | Numero da Vida do Componente |
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. | |
piConverteDecimal
Requisito | Nenhum | |
Sintaxe | run piConverteDecimal in h-handle (input <character>, output <character>). | |
Descrição | Realiza a troca da virgula (,) pelo (.). | |
| Parâmetros | Descrição |
| pcValor | Valor de Entrada |
| pcValorConvertido | Valor de Saída convertido |
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. | |
...
piValidaVidas
Requisito | Nenhum | |
Sintaxe | run piValidaVidas in h-handle (input <integer>, output <character>, output <character>). | |
Descrição | Realiza a validação das vidas do componente, retornando uma mensagem avisando a necessidade de atualizar o cadastro de vidas do componente. | |
| Parâmetros | Descrição |
| pnum-seqcial | Numero seqüencial do componente |
| pcMsgTitulo | Titulo da Mensagem de Retorno |
| pcMsgHelp | Help da Mensagem de Retorno |
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. | |
...
piBuscaUltimaVida
Requisito | Nenhum | |
Sintaxe | run piBuscaUltimaVida in h-handle (input <character>, output <integer>). | |
Descrição | Retorna a última vida do componente. | |
| Parâmetros | Descrição |
| pnumSeqcial | Numero seqüencial do componente |
| piNumVida | Vida do componente |
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. | |
...
piSugereDataInicial
Requisito | Nenhum | |
Sintaxe | run piSugereDataInicial in h-handle (input <character>, output <character>). | |
Descrição | Retorna a data final da última vida do componente. | |
| Parâmetros | Descrição |
| pnumSeqcial | Numero seqüencial do componente |
| pDatRetorno | Data Final da ultima vida do componente |
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. | |
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas