BOFR037 - Métodos referentes ao Relacionamento da tabela de Tarefa Plano

Documento de BO

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

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr037.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr037.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-tar-plano”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-model	Char	x(8)	Código do Modelo	Sim
cod-plano	Char	x(8)	Plano Manutenção	Sim
num-seq	Int	>>>,>>>	Número da sequência	Sim
cod-sub-sist	Char	x(8)	Código Sub-Sistema	Sim
cod-evento	Char	x(08)	Código do Evento	Sim
des-tarefa	Char	x(400)	Descrição Tarefa
val-tempo-padr	Dec	>>9.99	Tempo Padrão para Execução dos Serviços (horas)
cod-setor-ofici	Char	x(8)	Código do Setor da Oficina
cod-livre-1	Char	x(100)	Character Livre
cod-livre-2	Char	x(100)	Character Livre
log-livre-1	Log	Sim/Não	Logical Livre
log-livre-2	Log	Sim/Não	Logical Livre
num-livre-1	Int	->>>>>>>>9	Inteiro Livre
num-livre-2	Int	->>>>>>>>9	Inteiro Livre
val-livre-1	Dec	->>>>>>>>>>>9.9999	Decimal Livre
val-livre-2	Dec	->>>>>>>>>>>9.9999	Decimal Livre
dat-livre-1	Date	99/99/9999	Data Livre
dat-livre-2	Date	99/99/9999	Data Livre

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
	pcod-model	recebe valor do campo cod-model
	pcod-plano	recebe valor do campo cod-plano
	pnum-seq	recebe valor do campo num-seq
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
	pcod-model	recebe valor do campo cod-model
	pcod-plano	recebe valor do campo cod-plano
	pnum-seq	recebe valor do campo num-seq
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

linkToPlanoPrevent

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela mmv-tar-plano.
Sintaxe	run linkToPlanoPrevent in h-handle (input <hanlde>).
Descrição	Recebe como parâmetro o handle da BO da tabela mmv-tar-plano, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintPlanoPrevent”.
	Parâmetros	Descrição
	pHandle	Handle da BO “mmv-tar-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.

setConstraintCodPlManut

Requisito	Nenhum
Sintaxe	run setConstraintCodPlManut in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query por faixa de plano de manutenção.
	Parâmetros	Descrição
	pCodPlManutIni	Código Plano Manutenção Inicial
	pCodPlManutFim	Código Plano 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.

setConstraintNumSeq

Requisito	Nenhum
Sintaxe	run setConstraintNumSeq in h-handle (input <integer>, input <integer>).
Descrição	Seta as restrições para abrir a query pelo número da sequência.
	Parâmetros	Descrição
	pSeqIni	Código Número Sequência Inicial
	pSeqFim	Código Número Sequência 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.

setConstraintPlanoPrevent

Requisito	Nenhum
Sintaxe	run setConstraintPlanoPrevent in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query pelo modelo do equipamento e plano de manutenção.
	Parâmetros	Descrição
	pCodModelEqpto	Código Modelo Equipamento
	pCodPlManut	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.

setConstraintRowPlano

Requisito	Nenhum
Sintaxe	run setConstraintRowPlano in h-handle (input <rowid>).
Descrição	Seta as restrições para o plano preventiva, buscando a chave primária através do Rowid recebido como parâmetro.
	Parâmetros	Descrição
	pRow	Rowid da tabela “mmv-tar-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.

setConstraintTarefa

Requisito	Nenhum
Sintaxe	run setConstraintTarefa in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query pelo modelo e plano de manutenção.
	Parâmetros	Descrição
	pModel	Código Modelo
	pPlano	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.

openQueryCodPlManut

Requisito	A setConstraintCodPlManut ter sido executada anteriormente.
Sintaxe	run openQueryCodPlManut in h-handle.
Descrição	Abre a query da BO conforme a faixa de plano de manutenção passada na procedure setConstraintCodPlManut.
	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.

openQueryNumSeq

Requisito	A setConstraintNumSeq ter sido executada anteriormente.
Sintaxe	run openQueryNumSeq in h-handle.
Descrição	Abre a query da BO conforme a faixa do número da sequência passada na procedure setConstraintNumSeq.
	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.

openQueryPlano

Requisito	A setConstraintRowPlano ter sido executada anteriormente.
Sintaxe	run openQueryPlano in h-handle.
Descrição	Abre a query da BO conforme as restrições feitas pela procedure setConstraintRowPlano.
	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.

openQueryPlanoPrevent

Requisito	A setConstraintPlanoPrevent ter sido executada anteriormente.
Sintaxe	run openQueryPlanoPrevent in h-handle.
Descrição	Abre a query da BO conforme a faixa do modelo e plano de manutenção passada na procedure setConstraintPlanoPrevent.
	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.

openQueryTarefa

Requisito	A setConstraintTarefa e setConstraintNumSeq ter sido executada anteriormente.
Sintaxe	run openQueryTarefa in h-handle.
Descrição	Abre a query da BO conforme a faixa do modelo, plano de manutenção e número da sequência passada nas procedures setConstraintTarefa e setConstraintNumSeq.
	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	Verifica se registro existe e foi integrado.
	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....

atualizaSequencia

Requisito	Nenhum
Sintaxe	run atualizaSequencia in h-handle (input <character>, input <character>, output <integer>).
Descrição	Incrementa numero da sequencia conforme valor cadastrado no parametro 42 (mab-param).
	Parâmetros	Descrição
	pCodModel	Código do Modelo
	pCodPlano	Código Plano de Manutenção
	pSeq	Número da Sequência
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....

beforeDeleteRecord

Requisito	Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.
Sintaxe	run beforeDeleteRecord in this-procedure.
Descrição	Executa a procedure eliminafilhos passando o rowid da temp-table como parâmetro.
	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....

eliminaFilhos

Requisito	Nenhum
Sintaxe	run eliminaFilhos in h-handle (input <rowid>).
Descrição	Busca Compartimento do Equipamento para eliminação.
	Parâmetros	Descrição
	pRowid	Rowid da tabela mmv-tar-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 tt-erro....

copiaFilhos

Requisito	Nenhum
Sintaxe	run copiaFilhos in h-handle (input <character>, input <character>, input <integer>, input <character>, input <character>, input <integer>).
Descrição	Copia registros das tabelas filhas de um Plano para outro.
	Parâmetros	Descrição
	pModeloOrig	Código da Modelo Origem
	pPlanoOrig	Código Plano Origem
	pSeqOrig	Número Sequência Origem
	pModeloDest	Código da Modelo Destino
	pPlanoDest	Código Plano Destino
	pSeqDest	Número Sequência Destino
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....

criaRelacionamentoGrupo

Requisito	Nenhum
Sintaxe	run criaRelacionamentoGrupo in this-procedure.
Descrição	Criação do relacionamento entre grupo de equipamento e sub-sistema
	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....

criaTempoPadrao

Requisito	Nenhum
Sintaxe	run criaTempoPadrao in this-procedure.
Descrição	Criação do tempo padrão para modelo/evento/sub-sistema.
	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....

Árvore de páginas