Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr089 |
Considerações Gerais
Objetivo
Validação, Manutenção e acesso rápido a tabela “mab-histor-ativid”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-histor-ativid”.
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run frbo\bofr089.p. |
A sintaxe para executar a BO em modo persistente é:
run frbo\bofr089.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 de entrada e saída:
RowObject | Entrada/Saída | ||||
Tabela de comunicação entre Interface e banco de dados da tabela “mab-layout-import”. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
cod-prog-import | char | X(8) | Programa Importador | Sim / Key | 001 |
nom-bd | char | x(32) | Banco de Dados | Sim / Key | 001 |
nom-tabela | char | x(32) | Nome da Tabela | Sim / Key | 001 |
num-seq | int | >>>9 | Número da Sequência | Sim / Key | 001 |
nom-campo | char | x(32) | Nome do Campo | Sim | 001 |
num-tam-campo | int | >>,>>> | Tamanho do campo | Sim | 001 |
num-pos-inicial | int | >>,>>> | Posição Inicial | Sim | 001 |
num-pos-final | int | >>,>>> | Posição Final | Sim | 001 |
cod-tip-dado | char | x(12) | Tipo de dado | Sim | 001 |
qti-casas-dec | int | >9 | Quantidade de casas decimais | Não | 001 |
log-mandatorio | log | Sim/Não | Mandatório | Não | 001 |
cod-livre-1 | char | x(1000) | Character Livre | Não | 001 |
cod-livre-2 | char | x(1000) | 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 |
RowErrors | Entrada/Saída | ||||
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étodo Básico
Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
goToKey | ||
Requisito | Nenhum | |
Sintaxe | run goToKey in h-handle (input <integer>, input <character>, input <date>) | |
Descrição | Reposiciona a query com base na chave primária da tabela. | |
Parâmetros | Descrição | |
pcod-prog-import | Código do programa importador | |
pnom-bd | Nome do banco de dados | |
pnom-tabela | Nome da tabela | |
pnum-seq | Sequência do campo | |
Retorno | A 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>, output <date>). | |
Descrição | Retorna os campos da chave primária da tabela. | |
Parâmetros | Descrição | |
pcod-prog-import | Código do programa importador | |
pnom-bd | Nome do banco de dados | |
pnom-tabela | Nome da tabela | |
pnum-seq | Sequência do campo | |
Retorno | A 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 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 datas. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado. | |
pFieldValue | Valor do campo. | |
Retorno | A 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 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 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 <integer>). | |
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 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 <integer>). | |
Descrição | Retorna os valores dos campos da tabela que são longos. | |
Parâmetros | Descrição | |
pFieldName | Nome do campo a ser retornado. | |
pFieldValue | Valor do campo. | |
Retorno | A 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 <integer>). | |
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 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 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
setConstraintEquipamento | ||
Requisito | Nenhum | |
Sintaxe | run setConstraintEquipamento in h-handle (input <integer>, input <character>) | |
Descrição | Seta as restrições para abrir a query para o equipamento passado como parâmetro | |
Parâmetros | Descrição | |
pbanco | Nome do banco de dados | |
ptabela | Nome da tabela | |
pprograma | Código do programa | |
Retorno | A 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). |
setQueryMain | ||
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 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). |
openQueryPrograma | ||
Requisito | A setConstraintPrograma ter sido executada anteriormente. | |
Sintaxe | run openQueryPrograma in h-handle (input <character>, input <character>, input <character>) | |
Descrição | Abre a query da BO conforme a faixa de Código do Modelo do Equipamento passada na procedure setConstraintPrograma. | |
Parâmetros | Descrição | |
pprograma | Código do programa importador | |
pbanco | Nome do banco de dados | |
ptabela | Nome da tabela | |
Retorno | A 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). |
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 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 criação são especificados na temp-table RowErrors. |
createDefaultAB0702 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultAB0702 in <handle> | |
Descrição | Cria registros na tabela mab-layout-import de forma padrão para o programa AB0702. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultAB0705 in <handle> | |
Descrição | Cria os dados padrões da nom-tabela mab-layout-import para o programa AB0705. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705CTF | ||
Requisito | Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente. | |
Sintaxe | run createDefaultAB0705CTF in <handle> | |
Descrição | Define os dados iniciais do programa para criar layout default CTF. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705CTF-1 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultAB0705CTF-1 in <handle>. | |
Descrição | Criar layout default CTF. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705CTF-2 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultAB0705CTF-2 in <handle>. | |
Descrição | Continua a criação do layout default CTF. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705GoodCard | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultAB0705GoodCard in <handle> | |
Descrição | Define os dados iniciais do programa para criar layout default GoodCard. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705Outros | ||
Requisito | Nenhum. | |
Sintaxe | run createDefaultAB0705Outros in <handle>. | |
Descrição | Define os dados iniciais do programa para criar layout default Outros. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705Outros-1 | ||
Requisito | Nenhum. | |
Sintaxe | run createDefaultAB0705Outros-1 in <handle>. | |
Descrição | Criar layout default Outros. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultAB0705Outros-2 | ||
Requisito | Nenhum. | |
Sintaxe | run createDefaultAB0705Outros-2 in <handle>. | |
Descrição | Continua a criação do layout default Outros. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultGF0701 | ||
Requisito | Nenhum. | |
Sintaxe | run createDefaultGF0701 in <handle>. | |
Descrição | Cria registros na tabela mab-layout-import de forma padrão para o programa GF0701. | |
Parâmetros | Descrição | |
Não Contém |
| |
Retorno | A 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). |
createDefaultGF0702 | ||
Requisito | Nenhum. | |
Sintaxe | run createDefaultGF0702 in <handle>. | |
Descrição | Cria registros na tabela mab-layout-import de forma padrão para o programa GF0702. | |
Parâmetros | Descrição | |
pTipo | Tipo do programa que vai ser criado os registros. 1 = GF0702 2 = GF0702D | |
Retorno | A 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). |
createDefaultGF0703 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultGF0703 in <handle>. | |
Descrição | Cria registros na tabela mab-layout-import de forma padrão para o programa GF0703. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultND0701 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultND0701 in <handle>. | |
Descrição | Cria os dados padrões da mnd-enquad mab-layout-import para o programa. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createDefaultND0702 | ||
Requisito | Nenhum | |
Sintaxe | run createDefaultND0702 in <handle>. | |
Descrição | Cria os dados padrões da mnd-enquad mab-layout-import para o programa. | |
Parâmetros | Descrição | |
Não há |
| |
Retorno | A 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). |
createFieldOnGF0702Layout | ||
Requisito | Método interno utilizado pelo método createDefaultGF0702. | |
Sintaxe | run createFieldOnGF0702Layout in <handle> (input <character>, input <character>, input <logical>, input <integer>, input <integer>, input <integer>, input <character>, input <integer>, input <integer>, input <character>, input <character>). | |
Descrição | Cria registros na tabela mab-layout-import da forma que recebido através do método createDefailtGF0702. | |
Parâmetros | Descrição | |
Pdatabase | Nome do banco de dados | |
Pfieldname | Nome do campo | |
Pmandatory | Se obrigatório ou não | |
Plength | Tamanho do campo | |
Pstart | Posição de início do campo no arquivo | |
Pfinish | Posição de término do campo no arquivo | |
Pprogram | Nome do programa importador | |
Pdecimals | Número de decimais | |
Psequence | Seqüência do campo | |
Pfilename | Nome da tabela | |
Pdatatype | Tipo de dado do campo | |
Retorno | A 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). |
createLayout | ||
Requisito | Enviar os parâmetros. | |
Sintaxe | run createLayout in <handle> (input table <RowObject>, input <character>, input <character>, input <character>). | |
Descrição | Cria registros na tabela mab-layout-import de forma padrão para o programa GF0702. | |
Parâmetros | Descrição | |
prowobject | Tabela com informações do layout | |
pprograma | Código do programa importador | |
pbanco | Nome do banco de dados | |
ptabela | Nome da tabela | |
Retorno | A 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). |
findPosicao | ||
Requisito | Enviar os parâmetros. | |
Sintaxe | run findPosicao in <handle> (input <character>, input <character>, input <character>, input <integer>, output <integer>) | |
Descrição | Retorna a posição de uma determinada seqüência no layout. | |
Parâmetros | Descrição | |
pprograma | Código do programa importador | |
pbanco | Nome do banco de dados | |
ptabela | Nome da tabela | |
psequencia | Sequência do campo | |
| pposicao | Posição da seqüência no layout. |
Retorno | A 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). |
validaTamanho | ||
Requisito | Enviar os parâmetros. | |
Sintaxe | run validaTamanho in <handle> (input <character>, input <integer>, output <integer>). | |
Descrição | Retorna o tamanho de uma determinada seqüência no layout. | |
Parâmetros | Descrição | |
pPrograma | Código do programa importador | |
pSequencia | Sequência do campo | |
| pTamanho | Tamanho da sequência no layout. |
Retorno | A 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). |
validaTamanho-2 | ||
Requisito | Enviar os parâmetros. | |
Sintaxe | run validaTamanho-2 in <handle> (input <character>, input <integer>, output <integer>). | |
Descrição | Retorna o tamanho do formato do campo. | |
Parâmetros | Descrição | |
pPrograma | Código do programa importador | |
pSequencia | Sequência do campo | |
| pTamanho | Tamanho da sequência no layout. |
Retorno | A 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). |
criaMatrizUnidNegoc | ||
Requisito | Procedure chamada pelo programa abp/ab0705.w. Não deve ser chamada externamente. A BO deve estar rodando persistente na variável h-handle. | |
Sintaxe | run criaMatrizUnidNegoc in h-handle. | |
Descrição | Realiza acerto de base trocando o conteúdo do campo “mab-layout-import.nom-campo” de “cod_unid_negoc” para “cod-unid-negoc”. | |
Parâmetros | Descrição | |
Não Contém |
| |
Retorno | A 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. |