Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

Tabela Temporária

Descrição

Entrada/Saída

RowObject

Tabela de comunicação entre Interface e banco de dados da tabela “mao-restdo-ensaio”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Num-amostra-oleo

Int

>>>,>>>,>>9

Número do documento da Ficha de Amostra Óleo

Sim

cod-ensaio

char

x(8)

Código do ensaio

Sim

des-val-restdo

Char

X(40)

Valor Resultado do Ensaio

dat-restdo-ensaio

Date

99/99/9999

Data Resultado Ensaio

hra-restdo-ensaio

Char

99:99:99

Hora Resultado Ensaio

log-padrao

Log

Sim/Não

Ensaio Padrão

idi-estado-ensaio

Int

9

Estado do Ensaio

val-dat-hora-invrtda

Dec

999999999999

Data Hora Invertida

dsl-obs

Char

X(2000)

Observação

des-formato

Char

X(60)

Formato do resultado

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

cod-usuar-aprvdor

Char

x(12)

Código Usuário Aprovador

cod-livre-1

Char

X(100)

Livre 1

cod-livre-2

Char

X(100)

Livre 2

Log-livre-1

Log

Sim/Não

Livre 1

Log-livre-2

Log

Sim/Não

Livre 2

num-livre-1

Int

->>>>>>>>>9

Livre 1

num-livre-2

Int

->>>>>>>>>9

Livre 2

val-livre-1

Dec

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

Livre 1

val-livre-2

Dec

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

Livre 2

dat-livre-1

Date

99/99/9999

Livre 1

dat-livre-2

Date

99/99/9999

Livre 2

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

Requisito

Nenhum

Sintaxe

run goToKey in h-handle (input <integer>,

                         input <character>).

Descrição

Reposiciona o registro da atividade através do código da atividade.

Parâmetros

Descrição

Num-amostra-oleo

Número do documento da Ficha de Amostra Óleo

cod-ensaio

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.

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

Num-amostra-oleo

Número do documento da Ficha de Amostra Óleo

cod-ensaio

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.

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

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.

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.

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.

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.

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.

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.

Requisito

Nenhum

Sintaxe

run getValorCampos in h-handle (input  <integer>,

                                output <character>,

                                output <integer>,

                                output <integer>).

Descrição

Faz uma busca na tabela mao-amostra-oleo pelo número da amostra, retorna a amostra fisica, o número do evento e o estado.

Parâmetros

Descrição

pNumAmostra 

Número Amostra

pAmostraFisic

Amostra Física

pNumEvento  

Número Evento

pidEstado   

Estado

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

Sintaxe

run linkToAmostra in h-handle (input <hanlde>).

Descrição

Recebe como parâmetro o handle da BO da tabela mao-restdo-ensaio, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintAmostra”.

Parâmetros

Descrição

pHandle

Handle da BO.

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 setConstraintAmostra in h-handle (input <integer>).

Descrição

Carrega variáveis com o número da amostra para openQueryAmostra.

Parâmetros

Descrição

pNumAmostra

Número do documento da Ficha de Amostra Óleo

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 setConstraintFiltro in h-handle (input <integer>,

                                     input <character>),

                                     input <integer>,

                                     input <integer>).

Descrição

Carrega variáveis com a descrição inicial e final da atividade para o openQueryEnsaioFiltro.

Parâmetros

Descrição

pPendente  

Ensaio com estado Pendente

pAprovado

Ensaio com estado Aprovado

pAprovUsuar

Ensaio com estado Aprovado pelo Usuário

pReprovado

Ensaio com estado Reprovado

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 setConstraintResultado in h-handle (input <integer>,

                                     input <integer>),

                                     input <character>,

                                     input <character>).

Descrição

Carrega variáveis com a descrição inicial e final da atividade para o openQueryResultado.

Parâmetros

Descrição

pNumAmostraIni

Número do documento da Ficha de Amostra Óleo

pNumAmostraFim

Número do documento da Ficha de Amostra Óleo

pCodEnsaioIni

Código do Ensaio

pCodEnsaioFim

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.

Requisito

Nenhum

Sintaxe

run setConstraintRowAmostra in h-handle (input <rowid>).

Descrição

Carrega variáveis com a descrição inicial e final da atividade para o openQueryAmostra.

Parâmetros

Descrição

pRow

Rowid da tabela mao-amostra-oleo

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

Executar os métodos setConstraintAmostra.

Sintaxe

run openQueryAmostra in h-handle.

Descrição

Busca conjunto de registros da tabela mao-restdo-ensaio que sejam relativos ao número de amostra de óleo informado. Os registros são ordenados pelo Número do documento da Ficha de Amostra Óleo.

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

Executar os métodos setConstraintResultado, setConstraintFiltro.

Sintaxe

run openQueryEnsaioFiltro in h-handle.

Descrição

Busca conjunto de registros da tabela mao-restdo-ensaio dentro da faixa de numero de amostra de óleo e código de ensaio informada, tendo o flag de pendente selecionado e estado do ensaio igual a 1, ou flag de aprovado selecionado e estado do ensaio igual a 2, ou flag de aprovado pelo usuário selecionado e estado do ensaio igual a 3, ou flag de reprovado selecionado e estado do ensaio igual a 4. Os registros são ordenados pelo Número da amostra de óleo e pelo código do ensaio.

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

Nenhum

Sintaxe

run openQueryMain in h-handle.

Descrição

Busca conjunto de registros da tabela mao-restdo-ensaio. Os registros são ordenados pelo Número do documento da Ficha de Amostra Óleo.

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.

Requisito

Procedure chamada pelo método interno updateRecord. Não deve ser chamada externamente.

Sintaxe

run beforeUpdateRecord in this-procedure.

Descrição

Caso seja uma atualização (upd) feita pelo programa ao0302 - setado pelo setaPrograma, entao gravar o usuário

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

Requisito

Nenhum

Sintaxe

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

                                output <integer>).

Descrição

Busca pelo tipo de resultado do ensaio (Númerico,tabela,texto ou data)

Parâmetros

Descrição

pCodEnsaio

Recebe o código do ensaio  

pResultado

Retrono o tipo de resultado

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

Nenhum

Sintaxe

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

Descrição

Valida campo, caso ocorra erro retorna “NOK”.

Parâmetros

Descrição

pCampo

Campo recebido como parâmetro

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

Nenhum

Sintaxe

run validaData in h-handle (input <date>).

Descrição

Valida Data.

Parâmetros

Descrição

pData

Campo recebido como parâmetro

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