BOMN100 - Métodos de acesso e manutenção a tabela de Grupo Manutenção.

Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	mnbo/bomn100.p

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run mnbo\bomn100.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run mnbo\bomn100.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 “grup-manut”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
descricao	Char	x(30)	Descrição	Sim
controle	Int	>9	Controle	Sim
cd-equip-res	char	x(8)	Equipe Responsável
faixa-tempo	Int	>>>9	Faixa Tempo	sim
faixa-utiliz	dec	>>>>,>>9.99	Faixa Utilização	Sim
horas-parada	Dec	>>9.99	Tempo Parada	Sim
dias-manut	Int	>9	Utiliza	Sim
para-equipto	Int	>9	Forma Manut Equip
hr-extr-norm	Int	>9	Hora Trabalho	Sim
gera-pred	Log	Sim/Não	Gera Manut Preditiva
motivo	Char	x(2000)	Motivo
reporta	Int	>9	Reportar
cd-causa-padr	Char	X(8)	Causa	Sim
grp-manut	Char	X(8)	Grupo Manutenção	Sim
char-1	char	X(100)	Livre 1
char-2	char	X(100)	Livre 2
log-1	Log	Sim/Não	Livre 1
log- 2	Log	Sim/Não	Livre 2
int-1	Int	->>>>>>>>>9	Livre 1
int-2	Int	->>>>>>>>>9	Livre 2
dec-1	Dec	->>>>>>>>>>>9.9999	Livre 1
dec-2	Dec	->>>>>>>>>>>9.9999	Livre 2
data-1	date	99/99/9999	Livre 1
data-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

Tabela Temporária	Descrição	Entrada/Saída
ttGrupManut	Campos da tabela grupo manutenção utilizado nos planos manutenção.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdCausaPadr	char	padrão
cdEquipeRes	char	padrão
controle	INTEGER	padrão
faixaTempo	INTEGER	padrão
faixaUtiliz	char	padrão
paraEquipto	INTEGER	padrão
diasManut	INTEGER	padrão
hrExtrNorm	INTEGER
horasParada	char

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 o registro da Grupo Manutenção através do código do grupo manutenção.
	Parâmetros	Descrição
	pgrp-manut	Código do grupo 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.

getKey

Requisito	Nenhum
Sintaxe	run getKey in h-handle (output <character>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pcd-manut	Código da 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.

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

openQueryDefault

Requisito	Nenhum.
Sintaxe	run openQueryDefault in h-handle.
Descrição	Busca conjunto de registros da tabela grup-manut.
	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.

openQueryCdEquipRes

Requisito	Executar o método setConstraintCdEquipeRes.
Sintaxe	run openQueryCdEquipRes in h-handle.
Descrição	Busca conjunto de registros da tabela grup-manut com base em uma faixa inicial e final do código da equipe.
	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.

openQueryDescricao

Requisito	Executar o método setConstraintDescricao.
Sintaxe	run openQueryDescricao in h-handle.
Descrição	Busca conjunto de registros da tabela grup-manut com base em uma faixa inicial e final do código da descrição.
	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.

openQueryGrpManut

Requisito	Executar o método setConstraintGrpManut.
Sintaxe	run openQueryGrpManut in h-handle.
Descrição	Busca conjunto de registros da tabela grup-manut com base em uma faixa inicial e final do código do grupo de manutenção.
	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.

setConstraintCdEquipRes

Requisito	Nenhum
Sintaxe	run setConstraintCdEquipRes in h-handle (input < character >, input < character >).
Descrição	Seta as restrições para a equipe responsável.
	Parâmetros	Descrição
	pCdEquipResIni	Código da equipe responsável inicial
	pCdEquipResFim	Código da equipe responsável 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 para o tipo de manutenção.
	Parâmetros	Descrição
	pDescricaoIni	Descrição do tipo de manutenção inicial
	pDescricaoFim	Descrição do tipo de manutenção 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.

setConstraintGrpManut

Requisito	Nenhum
Sintaxe	run setConstraintGrpManut in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para o tipo de manutenção.
	Parâmetros	Descrição
	pGrpManutIni	Código do grupo manutenção inicial
	pGrpManutFim	Código do grupo manutenção 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.

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.

getRecordByKey

Requisito	Nenhum
Sintaxe	run getRecordByKey h-handle(input <character>, output ttGrupManut).
Descrição	Retorna temp-table com informações da Grupo Manutenção.
	Parâmetros	Descrição
	pGrpManut	Código do grupo manutenção.
	ttGrupManut	Temp-table ttGrupManut.
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