Linha Datasul

Árvore de páginas


Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr103


Objetivo

Validação, Manutenção e acesso rápido a tabela “mao-ensaio”.


Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mao-ensaio”.

Na forma padrão, realiza-se a chamada através de um comando RUN.

A sintaxe para a chamada BO é:

run frbo\bofr103.p.


A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr103.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 “mao-ensaio”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-ensaio

Char

x(8)

Código do ensaio

Sim


des-ensaio

Char

x(40)

Descrição do Ensaio

Sim


des-abrev

Char

x(10)

Descrição Abreviada



idi-tip-restdo

Int

9

Resultado do ensaio



des-formato

Char

x(60)

Formato do resultado do ensaio



des-val-min

Char

x(60)

Valor mínimo do resultado



des-val-max

Char

x(60)

Valor máximo do resultado



num-tabela

Int

>>>>9

Número da Tabela de Resultados



cod-livre-1

Char

x(100)

Character Livre



cod-livre-2

Char

x(100)

Character Livre



log-livre-1

Log

Sim/Não

Logical Livre



log-livre-2

Log

Sim/Não

Logical Livre



num-livre-1

Int

->>>>>>>>9

Inteiro Livre



num-livre-2

Int

->>>>>>>>9

Inteiro Livre



val-livre-1

Dec

->>>>>>>>>>>9.9999

Decimal Livre



val-livre-2

Dec

->>>>>>>>>>>9.9999

Decimal Livre



dat-livre-1

Date

99/99/9999

Data Livre



dat-livre-2

Date

99/99/9999

Data Livre



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


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 <character>).

Descrição

Reposiciona a query com base na chave primária da tabela.

 

Parâmetros

Descrição

 

pcod-ensaio

recebe valor do campo cod-ensaio

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 (input <character>).

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

pcod-ensaio

recebe valor do campo cod-ensaio

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 / LinkTo

setConstraintCodigo

Requisito

Nenhum         

Sintaxe

run setConstraintCodigo in h-handle (input <character>,

                                     input <character>).

Descrição

Seta as restrições por faixa do Código do ensaio.

 

Parâmetros

Descrição

 

pEnsaioIni

Código do ensaio Inicial

pEnsaioFim

Código do ensaio Final

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.


setConstraintDescricao

Requisito

Nenhum         

Sintaxe

run setConstraintDescricao in h-handle (input <character>,

                                        input <character>).

Descrição

Seta as restrições por Descrição do Ensaio.

 

Parâmetros

Descrição

 

pDescIni

Descrição do Ensaio Inicial

pDescFim

Descrição do Ensaio Final

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.


setConstraintEnsaio

Requisito

Nenhum         

Sintaxe

run setConstraintEnsaio in h-handle (input <character>).

Descrição

Seta as restrições por Código do ensaio.

 

Parâmetros

Descrição

 

pEnsaio

Código do ensaio

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.


setConstraintFiltro

Requisito

Nenhum         

Sintaxe

run setConstraintFiltro in h-handle (input <logical>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>).

Descrição

Seta as restrições por Resultado do ensaio.

 

Parâmetros

Descrição

 

pNumero

Resultado do ensaio = 1

pTabela

Resultado do ensaio = 2

pTexto

Resultado do ensaio = 3

pData 

Resultado do ensaio = 4

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.


openQueryEnsaio

Requisito

A setConstraintEnsaio ter sido executada anteriormente.

Sintaxe

run openQueryEnsaio in h-handle.

Descrição

Abre a query pelo código do ensaio.

Abre a query para uma faixa de modelo e plano.

 

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.


openQueryFiltroCodigo

Requisito

A setConstraintFiltro e setConstraintCodigo terem sido executadas anteriormente.

Sintaxe

run openQueryFiltroCodigo in h-handle.

Descrição

Abre a query da BO conforme as restrições passadas nas procedures setConstraintFiltro e setConstraintCodigo.

Abre a query para uma faixa de modelo e plano e para um equipamento.

 

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.

openQueryFiltroDescricao

Requisito

A setConstraintFiltro e setConstraintDescricao terem sido executadas anteriormente.

Sintaxe

run openQueryFiltroDescricao in h-handle.

Descrição

Abre a query da BO conforme as restrições passadas nas procedures setConstraintFiltro e setConstraintDescricao.

Abre a query para uma faixa de modelo e plano e para um equipamento.

 

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.

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.

validaCampo

Requisito

Nenhum.

Sintaxe

run validaCampo in this-procedure (input <character>).

Descrição

Valida os campos.

 

Parâmetros

Descrição

 

pCampo

 Nome 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.

buscaRegistros

Requisito

Nenhum.

Sintaxe

run buscaRegistros in this-procedure (output <table>).

Descrição

Busca registros e grava em uma temp-table.

 

Parâmetros

Descrição

 

tt-ensaio

Temp-table

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.

copiaFilhos

Requisito

Nenhum.

Sintaxe

run copiaFilhos in this-procedure (input <character>,

                                   input <character>).

Descrição

Copia os filhos do Ensaio selecionado.

 

Parâmetros

Descrição

 

pCodEnsaioOrig

Código do Ensaio Origem

pCodEnsaioDest

Código do Ensaio Destino

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.

desabilitaCampo

Requisito

Nenhum.

Sintaxe

run desabilitaCampo in this-procedure (input  <character>,

                                       output <logical>).

Descrição

Faz busca utilizando código do ensaio.

 

Parâmetros

Descrição

 

pCodEnsaio

Código do Ensaio

pOK

Yes/No

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.