Histórico da Página
...
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr129 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mco-compon-caract”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mco-compon-caract”.
...
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-compon-caract”. | Entrada/Saída |
...
Requisito | Nenhum | |
Sintaxe | run goToKey in h-handle (input <integer>, input <character>). | |
Descrição | Reposiciona a query com base na chave primária da tabela. | |
| Parâmetros | Descrição |
| pnum-seqcial | recebe valor do campo num-seqcial |
pcod-caract | recebe valor do campo cod-caract | |
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 <character>). | ||||||
Descrição | Retorna os campos da chave primária da tabela. | ||||||
| Parâmetros | Descrição | |||||
| pnum-seqcial | recebe valor do campo num-seqcial | |||||
pcod-caract | recebe valor do campo cod-caract | ||||||
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. | |
...
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
...
Requisito | Nenhum | |
Sintaxe | run buscaCatalogo in h-handle (input <character>, output <logical>). | |
Descrição | Retorna se a característica possui catálogo de documento. | |
| Parâmetros | Descrição |
| pcod-caract | Código da Característica |
p-ok | Variável lógica 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 RowErrors.
| |
piAddCaractCompon
Requisito | Nenhum | |
Sintaxe | run piAddCaractCompon in h-handle (input <integer>, input <character>, input <character>, input <character>, output <temp-table>). | |
Descrição | Realizar a gravação da tabela “mco-compon-caract” com base nas informações recebidas por parâmetros. | |
| Parâmetros | Descrição |
| pNumSeqcial | Numero Sequencial do Componente |
pCodCaract | Código da característica | |
pDesCaract | Descrição da característica | |
pDesArquivo | Descrição do Arquivo relacionado a característica | |
RowErrors | Temp-table com os erros de gravação. (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 RowErrors. | |
...
Requisito | Nenhum | |
Sintaxe | run piUpdateCaractCompon in h-handle (input <integer>, input <character>, input <character>, input <character>, output <temp-table>). | |
Descrição | Realizar a alteração da tabela “mco-compon-caract” com base nas informações recebidas por parâmetros. | |
| Parâmetros | Descrição |
| pNumSeqcial | Numero Sequencial do Componente |
pCodCaract | Código da característica | |
pDesCaract | Descrição da característica | |
pDesArquivo | Descrição do Arquivo relacionado a característica | |
RowErrors | Temp-table com os erros de gravação. (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 RowErrors.
| |
piGetCaractCompon
Requisito | Nenhum | |
Sintaxe | run piGetCaractCompon in h-handle (input <integer>, output <temp-table>). | |
Descrição | Retorna as Características do Componente. | |
| Parâmetros | Descrição |
| pNumSeqcial | Numero Sequencial do Componente |
ttCaractComponAux | Temp-table com as características do componente (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 RowErrors. | |
piGetInfCaractCompon
Requisito | Nenhum | |
Sintaxe | run piGetInfCaractCompon in h-handle (input <integer>, input <character>, output <character>, output <character>). | |
Descrição | Retorna informações da Característica do componente. | |
| Parâmetros | Descrição |
| pNumSeqcial | Numero Sequencial do Componente |
pCodCaract | Código da Característica | |
pDesCaract | Descrição da Característica do Componente | |
pDesArquivo | Descrição do Arquivo realizado a Característica | |
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 | Nenhum | |
Sintaxe | run piDelCaractCompon in h-handle (input <integer>, input <character>, output <temp-table>). | |
Descrição | Realizar a exclusão da tabela “mco-compon-caract” com base nas informações recebidas por parâmetros. | |
| Parâmetros | Descrição |
| pNumSeqcial | Numero Sequencial do Componente |
pCodCaract | Código da característica | |
RowErrors | Temp-table com os erros de gravação. (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 RowErrors. | |