BOFR031 - Métodos para manutenção e acesso à tabela de Equipamento Plano

Documento de BO

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

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr031.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr031.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 “mmv-eqpto-plano”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ep-codigo	Int	>>9	Código da empresa do equipamento	Sim
cod-eqpto	Char	x(16)	Código do Equipamento	Sim
cod-plano	Char	x(8)	Plano Manutenção	Sim
dat-inicial	Date	99/99/9999	Data Inicial	Sim
dat-final	Date	99/99/9999	Data final de controle do plano no equipamento	Não
val-km-inicial	Dec	>>,>>>,>>9.9	Utilização Inicial	Sim
val-km-real	Dec	>>,>>>,>>9.9	Uso Real, de acordo com a unidade	Sim
dat-atualiz	Date	99/99/9999	Data da última baixa do plano de manutenção.	Não
cod-livre-1	Char	x(100)	Character Livre	Não
cod-livre-2	Char	x(100)	Character Livre	Não
log-livre-1	Log	Sim/Não	Logical Livre	Não
log-livre-2	Log	Sim/Não	Logical Livre	Não
num-livre-1	Int	->>>>>>>>9	Inteiro Livre	Não
num-livre-2	Int	->>>>>>>>9	Inteiro Livre	Não
val-livre-1	Dec	->>>>>>>>>>>9.9999	Decimal Livre	Não
val-livre-2	Dec	->>>>>>>>>>>9.9999	Decimal Livre	Não
dat-livre-1	Date	99/99/9999	Data Livre	Não
dat-livre-2	Date	99/99/9999	Data Livre	Não

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>, input <character>, input <character>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pep-codigo	recebe valor do campo ep-codigo
	pcod-eqpto	recebe valor do campo cod-eqpto
	pcod-plano	recebe valor do campo cod-plano
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>, output <character>, output <character>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pep-codigo	recebe valor do campo ep-codigo
	pcod-eqpto	recebe valor do campo cod-eqpto
	pcod-plano	recebe valor do campo cod-plano
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

linkToEquipamento

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela mmv-eqpto-plano.
Sintaxe	run linkToEquipamento in h-handle (input <hanlde>).
Descrição	Busca o equipamento e abre seta as restri‡äes para abertura da query.
	Parâmetros	Descrição
	pHandle	Handle da DBO de Equipamento
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 <character>).
Descrição	Seta as restrições para abertura da query por equipamento.
	Parâmetros	Descrição
	pCdnEmpresa	Código da Empresa
	pCodEqpto	Código do Equipamento
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.

setConstraintFaixaEquipamento

Requisito	Nenhum
Sintaxe	run setConstraintFaixaEquipamento in h-handle (input <integer>, input <integer>, input <character>, input <character>).
Descrição	Seta as restrições para abertura da query por equipamento
	Parâmetros	Descrição
	pCdnEmpresaIni	Código da Empresa Inicial
	pCdnEmpresaFim	Código da Empresa Final
	pCodEqptoIni	Código do Equipamento Inicial
	pCodEqptoFim	Código do Equipamento 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.

openQueryEquipamento

Requisito	A setConstraintEquipamento ter sido executada anteriormente.
Sintaxe	run openQueryEquipamento in h-handle.
Descrição	Abre a query com os registros de 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.

openQueryFaixaEquipamento

Requisito	Abre a query com os registros de um equipamento.
Sintaxe	run openQueryFaixaEquipamento in h-handle.
Descrição	Abre a query com os registros de 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.

consisteDataControle

Requisito	Nenhum
Sintaxe	run consisteDataControle in this-procedure (input <integer>, input <character>, input <character>).
Descrição	Verifica se data início é menor que data de controle do eqpto.
	Parâmetros	Descrição
	pEmpresa	Código da Empresa
	pEqpto	Código do Equipamento
	pData	Data Início
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....

consisteTipoPlano

Requisito	Nenhum
Sintaxe	run consisteTipoPlano in this-procedure (input <integer>, input <character>, input <character>, input <character>).
Descrição	Validações referentes ao plano de manutenção.
	Parâmetros	Descrição
	pEmpresa	Código Empresa
	pEqpto	Código Equipamento
	pPlano	Código Plano Manutenção
	pTipo	Tipo de Plano de Manutençã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...

piVerificaPlanoCalendario

Requisito	Método interno chamado pela procedure “validateRecord”.
Sintaxe	run piVerificaPlanoCalendario in this-procedure (input <date>, input <integer>, input <character>, input <character>).
Descrição	Validações referentes ao plano de manutenção, para ver se o mesmo não está vinculado a nenhum calendário da manutenção.
	Parâmetros	Descrição
	pDataValidad	Data de Validade do Plano de Manutenção
	pEmpresa	Código Empresa
	pEqpto	Código Equipamento
	pPlano	Código Plano Manutençã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 RowErrors “tt-erro”.

Árvore de páginas