Exibir origem

Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	frbo/bofr105

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr105.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr105.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-amostra-oleo”.	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-amostra-fisic	char	x(12)	Número / Código da Amostra Física do Óleo (Frasco)
dat-amostra	date	99/99/9999	Data da Amostra de Óleo	Sim
Hra-amostra	char	99:99:99	Hora da Amostra de Óleo	Sim
ep-codigo	Int	>>9	Código da Empresa
cod-eqpto	char	X(16)	Código do Equipamento
val-dat-hora-invrtda	dec	999999999999	Data Hora Invertida
num-docto	Int	>>>,>>>,>>9	Número da ficha de Lubrificação
cod-comptmento	Char	X(8)	Código do Compartimento
cod-evento	Char	X(8)	Código do Evento
cod-tip-mater	Char	X(8)	Código do Tipo de Material
It-codigo	Char	X(16)	Código do item
val-quant	Dec	>,>>>,>>9.99	Indica a Quantidade
idi-estado-amostra	Int	9	Estado da Amostra
cod-usuar	Char	X(12)	Código do usuário
cod-usuar-aprvdor	Char	X(12)	Código Usuário Aprovador
dsl-obs	Char	X(2000)	Observação
num-docto-event	Int	>>>,>>>,>>9	Documento Evento
cod-livre-1	Char	X(100)	Livre 1	Sim
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

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

setConstraintData

Requisito	Nenhum
Sintaxe	run setConstraintData in h-handle (input <date>, input <date>).
Descrição	Carrega variáveis com código da Atividade inicial e final para openQueryData.
	Parâmetros	Descrição
	pDataIni	Data Amostra
	pDataFim	Data Amostra
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.

setConstraintDocumento

Requisito	Nenhum
Sintaxe	run setConstraintDocumento in h-handle (input <integer>, input <character>, input <character>, input <character>).
Descrição	Carrega variáveis com a descrição inicial e final da atividade para o openQueryDocumento.
	Parâmetros	Descrição
	pDoctoIni	Número da ficha de Lubrificação
	pDoctoFim	Número da ficha de Lubrificação
	pAmostraIni	Número / Código da Amostra Física do Óleo (Frasco)
	pAmostraFim	Número / Código da Amostra Física do Óleo (Frasco)
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.

setConstraintEquipamento

Requisito	Nenhum
Sintaxe	run setConstraintEquipamento in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <character>, input <character>).
Descrição	Carrega variáveis com a descrição inicial e final da atividade para o openQueryEquipamento.
	Parâmetros	Descrição
	pEmpIni	Código da Empresa
	pEmpFim	Código da Empresa
	pEqptoIni	Código do Equipamento
	pEqptoFim	Código do Equipamento
	pComtpIni	Código do Compartimento
	pComtpFim	Código do Compartimento
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.

setConstraintMaterial

Requisito	Nenhum
Sintaxe	run setConstraintMaterial in h-handle (input <character>, input <character>, input <character>, input <character>).
Descrição	Carrega variáveis com a descrição inicial e final da atividade para o openQueryMaterial.
	Parâmetros	Descrição
	pMaterIni	Código do Tipo de Material
	pMaterFim	Código do Tipo de Material
	pItemIni	Código do item
	ptemFim	Código do item
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	Nenhuma.
Sintaxe	run openQueryMain in h-handle.
Descrição	Busca conjunto de registros da tabela mao-amostra-oleo. s 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.

openQueryData

Requisito	Executar os métodos setConstraintData.
Sintaxe	run openQueryData in h-handle.
Descrição	Busca conjunto de registros da tabela mao-amostra-oleo dentro da faixa de data informada. 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.

openQueryDocumento

Requisito	Executar os métodos setConstraintDocumento .
Sintaxe	run openQueryDocumento in h-handle.
Descrição	Busca conjunto de registros da tabela mao-amostra-oleo dentro da faixa de numero de documento e código da amostra física informada. 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.

openQueryEquipamento

Requisito	Executar os métodos setConstraintEquipamento.
Sintaxe	run openQueryEquipamento in h-handle.
Descrição	Busca conjunto de registros da tabela mao-amostra-oleo dentro da faixa de código da empresa, código de equipamento e código de compartimento informada. 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.

openQueryMaterial

Requisito	Executar os métodos setConstraintMaterial.
Sintaxe	run openQueryMaterial in h-handle.
Descrição	Busca conjunto de registros da tabela mao-amostra-oleo dentro da faixa de código do tipo de material e código do item informada. 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.

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.

afterCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run afterCreateRecord in this-procedure.
Descrição	Busca o modelo do 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 tt-erro....

afterDeleteRecord

Requisito	Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.
Sintaxe	run afterDeleteRecord in this-procedure.
Descrição	Roda o método na Bo da ficha de lubrificação para atualizar os registros com base no registro Eliminado.
	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....

beforeUpdateRecord

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

buscaDescricao

Requisito	Nenhum
Sintaxe	run buscaDescricao in h-handle (input <integer>, input <character>, output <character>).
Descrição	Busca equipamento por código da empresa e equipamento, e grava descrição do modelo.
	Parâmetros	Descrição
	pEmpresa	Código Empresa
	pEqpto	Código Equipamento
	pModel	Descrição Modelo
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....

buscaDescricaoCompto

Requisito	Nenhum
Sintaxe	run buscaDescricaoCompto in h-handle (input <character>, output <character>).
Descrição	Busca compartimento pelo código do compartimento, e grava sua descrição.
	Parâmetros	Descrição
	pCompto	Código Compartimento
	pDescricao	Descrição Compartimento
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....

buscaDescricaoMatl

Requisito	Nenhum
Sintaxe	run buscaDescricaoMatl in h-handle (input <character>, output <character>).
Descrição	Busca tipo material pelo código tipo material, e grava descrição.
	Parâmetros	Descrição
	pCdMatl	Código Tipo Material
	pDescricao	Descrição Tipo Material
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....

buscaDescricaoDocumento

Requisito	Nenhum
Sintaxe	run buscaDescricaoDocumento in h-handle (output <integer>).
Descrição	Busca a próxima numeração do documento.
	Parâmetros	Descrição
	pDoc	Número do 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 tt-erro....

converteParaHoraInvertida

Requisito	Nenhum
Sintaxe	run converteParaHoraInvertida in h-handle (input <character>, input <character>, output <decimal>).
Descrição	Recebe a data e a hora, converte e retorna no formato de data e hora invertida.
	Parâmetros	Descrição
	pData	Data corrente do sistema
	pHora	Hora corrente do sistema
	pInvertida	Data e hora invertida inicial
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....

copiaFilhos

Requisito	Nenhum
Sintaxe	run copiaFilhos in h-handle (input <integer>, input <integer>, input-output <table>).
Descrição	Faz a copia dos filhos ao copiar o Usuario.
	Parâmetros	Descrição
	i-destino
	i-origem
	RowErrorsAux
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....

eliminaFilhos

Requisito	Nenhum
Sintaxe	run eliminaFilhos in h-handle (input <rowid>).
Descrição	Elimina todos os registros da tabela filha(mao-restdo-ensaio) associados a tabela pai da ficha de analise de óleo
	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 tt-erro....

criaResultadoModelo

Requisito	Nenhum
Sintaxe	run criaResultadoModelo in h-handle (input <character>).
Descrição	Cria a tabela filha(mao-restdo-ensaio) para o registro criado na tabela da ficha da analise de óleo.
	Parâmetros	Descrição
	pCodModel	Código Modelo
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....

validaAmostra

Requisito	Nenhum
Sintaxe	run validaAmostra in h-handle (input <table> output <integer>).
Descrição	Faz uma busca na temp-table e retorna o estado do ensaio.
	Parâmetros	Descrição
	ttDados	Temp-table.
	pAmostra	Estado 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 tt-erro....

validaResultados

Requisito	Nenhum
Sintaxe	run validaResultados in h-handle (input-output <table>).
Descrição	Valida Resultado.
	Parâmetros	Descrição
	ttDados	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 tt-erro....