BOFR078 - Métodos para manutenção e acesso à tabela de Tempo Padrão

Documento de BO

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

Objetivo

Validação, Manutenção e acesso rápido a tabela “mmv-tempo-padr”.

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr078.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr078.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 “mab-motoris”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-model	Char	X(8)	Código do Modelo	Sim
cod-sub-sist	char	X(8)	Código Sub-Sistema	Sim
cod-evento	Char	X(8)	Código do Evento	Sim
val-tempo-padr	Dec	>>9.99	Tempo Padrão	Sim
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

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>, input <character>, input <character>).
Descrição	Reposiciona o registro da estrutura mecânica através do código do motorista.
	Parâmetros	Descrição
	pcod-model	Código do modelo
	pcod-sub-sist	Código Sub-Sistema
	pcod-evento	Código do Evento
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 <character>, output <character>, output <character>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pcod-model	Código do modelo
	pcod-sub-sist	Código Sub-Sistema
	pcod-evento	Código do Evento
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

setConstraintModelo

Requisito	Nenhum
Sintaxe	run setConstraintModelo in h-handle (input <character>).
Descrição	Carrega as variável com uma faixa inicial e final do código do modelo para openQueryCodModelo.
	Parâmetros	Descrição
	pModIni	Código do Modelo 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 RowErrors.

setConstraintModSub

Requisito	Nenhum
Sintaxe	run setConstraintModSub in h-handle (input <character>, input <character>, input <character>, input <character>).
Descrição	Carrega as variável com uma faixa inicial e final do código do modelo e subsistema para openQueryModSub.
	Parâmetros	Descrição
	pModIni	Código do Modelo Inicial
	pModFim	Código do Modelo Final
	psubini	Código SubSistema Inicial
	psubFim	Código SubSistema 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.

openQueryModelo

Requisito	Executar o método setConstraintModelo.
Sintaxe	run openQueryModelo in h-handle.
Descrição	Busca conjunto de registros da tabela mmv-tempo-padr com base em uma faixa inicial e final do código do modelo. Os registros são ordenados pelo código do motorista.
	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.

openQueryModSub

Requisito	Executar o método setConstraintModSub.
Sintaxe	run openQueryModSub in h-handle.
Descrição	Busca conjunto de registros da tabela mmv-tempo-padr com base em uma faixa inicial e final do código do modelo e subsitema. Os registros são ordenados pelo código do motorista.
	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	Busca conjunto de registros da tabela mmv-tempo-padr. Os registros são ordenados pelo código do motorista.
	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.

openQueryDefault

Requisito	Nenhum.
Sintaxe	run openQueryDefault in h-handle.
Descrição	Busca conjunto de registros da tabela mmv-tempo-padr. Os registros são ordenados pelo código do motorista.
	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.

CopiaTempoPadr

Requisito	Nenhum
Sintaxe	run CopiaTempoPadr in h-handle (input <character>, input <character>, input <logical>).
Descrição	Copia de TempoPadrao do Modelo.
	Parâmetros	Descrição
	piModeloOrigem	Código Modelo Origem
	piModeloDestino	Código Modelo Destino
	piSobrepor	Sim/Não
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....

CopiaTempoPadrMetaDados

Requisito	Nenhum
Sintaxe	run CopiaTempoPadrMetaDados in h-handle (input <character>, input <character>, input <logical>, output <RowErrors>).
Descrição	Copia de TempoPadrao do Modelo, retorna a RowErros com os erros que impediram a cópia.
	Parâmetros	Descrição
	piModeloOrigem	Código Modelo Origem
	piModeloDestino	Código Modelo Destino
	piSobrepor	Sim/Não
	RowErrors	Temp-table com erros que impediram a cópia
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....

Árvore de páginas