BOMN106 - Métodos de acesso e manutenção a tabela de Plano de Equipamento no Tag.

Documento de BO

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

Objetivo

Validação, Manutenção e acesso rápido a tabela “man-eq-tag”.

Funcionamento

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

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

A sintaxe para a chamada BO é:

run mnbo\bomn106.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run mnbo\bomn106.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 “man-eq-tag”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cd-manut	Char	x(8)	Manutenção	Sim
cd-tag	Char	x(16)	Tag	Sim
descricao	Char	x(50)	Descrição	Sim
dt-inicio	Date	99/99/9999	Data Início	Sim
dt-termino	Date	99/99/9999	Data Término
situacao	Int	>9	Situação	Sim
controle	Int	>9	Controle	Sim
cd-equip-res	char	x(8)	Equipe Responsável
prioridade	Int	ZZ9	Prioridade	sim
mot-suspensao	Char	X(76)	Motivo
narrativa	Char	x(2000)	Narrativa	sim
flexib-antec	Int	999	Flex Antec
flexib-prorr	Int	999	Flex Prorr
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
hr-extr-norm	Int	>9	Hora Trabalho	Sim
gera-pred	Log	Sim/Não	Gera Manut Preditiva
horas-prod	dec	>>9	Parada Produção
om-gerada	Log	Sim/Não	OMP Gerada
tp-dia	Int	>9	Tipo Dia
para-equipto	Int	>9	Forma Manut Equip
parada	Log	Sim/Não	parada	Sim
cd-tipo	Int	>>,>>9	Tipo Manutenção	Sim
gera-parada	Int	>9	Gera Ordem Parada	Sim
cd-parada	Char	X(8)	Parada
dur-man	Int	>>>9	Duração Manutenção
cd-causa-padr	Char	X(8)	Causa	Sim
cd-sint-padr	Char	X(8)	Sintoma Padrão	Sim
cd-interv-padr	Char	X(8)	Intervenção	Sim
cd-pend-padr	Char	X(8)	Pendência Padrão	Sim
liber-tarefa	Int	9	Liberação Tarefa
cd-inspecao	Char	X(8	Inspeção
cd-equipto	Char	X(16)	Equipamento	Sim
forma-aloc-esp	Int	>9	Forma Alocação Especialidade
cons-dur-man	Log	Sim/Não	Considera Duração Manutenção
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
cd-planejado	Char	X(12)	Planejador
nr-ult-seq	Int	>>>>9	Última Seqüência
urgencia	Int	>9	Urgência

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 Plano de Equipamento no Tag através do código do equipamento, da tag e da manutenção.
	Parâmetros	Descrição
	pcd-equipto	Código do Equipamento.
	pcd-tag	Código da tag
	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.

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
	pcd-equipto	Código do Equipamento.
	pcd-tag	Código da tag
	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

linkToTipoManut

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela tipo-manut.
Sintaxe	run linkToTipoManut in h-handle (input <hanlde>).
Descrição	Faz o JOIN entre as tabelas “tipo-manut” e “man-eq-tag”. Recebe como parâmetro o handle da BO da tabela tipo-manut, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintTipoManut”.
	Parâmetros	Descrição
	pHandle	Handle da BO “tipo-manut” (Tipo-Manut).
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 man-eq-tag.
	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.

openQueryCdManut

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

openQueryTipoManut

Requisito	Executar o método setConstraintTipoManut.
Sintaxe	run openQueryTipoManut in h-handle.
Descrição	Busca conjunto de registros da tabela man-eq-tag com base em uma faixa inicial e final do tipo 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.

setConstraintCdEquipto

Requisito	Nenhum
Sintaxe	run setConstraintCdEquipto in h-handle (input <character>).
Descrição	Seta as restrições para o equipamento.
	Parâmetros	Descrição
	pCdEquipto	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.

setConstraintCdManut

Requisito	Nenhum
Sintaxe	run setConstraintCdManut in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para a manutenção.
	Parâmetros	Descrição
	pCdManutIni	Código da manutenção inicial
	pCdManutFim	Código da 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.

setConstraintCdTag

Requisito	Nenhum
Sintaxe	run setConstraintCdTag in h-handle (input <character>).
Descrição	Seta as restrições para a tag.
	Parâmetros	Descrição
	pCdTag	Código da tag
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.

setConstraintTipoManut

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

pi-desativa-planos-classe-preditiva

Requisito	Nenhum.
Sintaxe	run pi-desativa-planos-classe-preditiva in h-handle(input<character>).
Descrição	Desativa os planos que possuem classe preditiva.
	Parâmetros	Descrição
	p-cd-equipto	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 tt-erro....

afterCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run afterCreateRecord in this-procedure.
Descrição	Metodo executado após a atualização do registro.
	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....

afterUpdateRecord

Requisito	Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.
Sintaxe	run afterUpdateRecord in this-procedure.
Descrição	Metodo executado após a atualização do registro.
	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....

atualizaPreditiva

Requisito	nenhum.
Sintaxe	run atualizaPreditiva in h-handle(input<character>, input <integer>).
Descrição	Atualiza dados para o módulo preditiva.
	Parâmetros	Descrição
	pcdEquito	Código do equipamento
	pcdTipo	Código do tipo 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....

verificaPreditivaImplantada

Requisito	Nenhum
Sintaxe	run verificaPreditivaImplantada h-handle(output <logical>).
Descrição	Retorna se o módulo preditiva está implantado ou não.
	Parâmetros	Descrição
	l-log-modul-predit	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....

getTipoControle

Requisito	Nenhum
Sintaxe	run getTipoControle h-handle(input <character>, input <character>, input <character>, output <integer>).
Descrição	Retorna o tipo de controle do plano equipamento tag.
	Parâmetros	Descrição
	pcd-equipto	Código Equipamento
	pcd-tag	Código tag
	pcd-manut	Código da Manutenção Padrão.
	p-controle	Tipo Controle
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....

copiaPlanoEquipamentoTag

Requisito	Nenhum.
Sintaxe	run copiaPlanoEquipamentoTag h-handle(input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, output RowErrors).
Descrição	Faz uma cópia de um plano equipamento tag com as tarefas e seus relacionamentos.
	Parâmetros	Descrição
	c-equipto-orig	Código do Equipamento origem
	c-equipto-dest	Código do Equipamento destino
	c-cd-tag-orig	Código da Tag origem
	c-cd-tag-dest	Código da Tag destino
	c-manut-origem	Código da Manutenção padrão Origem
	c-manut-destino	Código da Manutenção Padrão criada
	RowErrors	Temp-table com os erros.
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