BOFR071 - Métodos para manutenção e acesso à tabela de Equipamento Calendário Plano

Documento de BO

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

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr071.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

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

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
dat-movto	Date	99/99/9999	Data Programação Manutenção	Sim
cod-ofici	Char	x(8)	Código da Oficina	Sim
ep-codigo	Int	>>9	Código da empresa do equpamento	Sim
cod-eqpto	Char	x(16)	Código Equipamento	Sim
cod-plano	Char	x(8)	Plano Manutenção	Sim
hra-inicial	Char	99:99:99	Hora Inicial
hra-final	Char	99:99:99	Hora Final
dat-final	Date	99/99/9999	Data Previsão Término Serviço
nr-ord-produ	Int	>>>,>>>,>>9	Número da Ordem de Manutenção
num-docto-movto-event	Int	>>>,>>>,>>9	Número Documento Movimento Evento
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 <date>, input <character>, input <integer>, input <character>, input <character>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pdat-movto	recebe valor do campo dat-movto
	pcod-ofici	recebe valor do campo cod-ofici
	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 (input <date>, input <character>, input <integer>, input <character>, input <character>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pdat-movto	recebe valor do campo dat-movto
	pcod-ofici	recebe valor do campo cod-ofici
	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

setConstraintData

Requisito	Nenhum
Sintaxe	run setConstraintData in h-handle (input <date>).
Descrição	Seta as restrições por faixa de data de movimento.
	Parâmetros	Descrição
	pDtIni	Data de Movimento inicial
	pDtFim	Data de Movimento 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.

setConstraintEqpto

Requisito	Nenhum
Sintaxe	run setConstraintEqpto in h-handle (input <date>, input <date>, input <character>, input <character>, input <character>, input <character>, input <integer>, input <integer>, input <character>, input <character>).
Descrição	Seta as restrições por faixa de equipamento.
	Parâmetros	Descrição
	pDtIni	Data Programação Manutenção Inicial
	pDtFim	Data Programação Manutenção Final
	pOficiIni	Código da Oficina Inicial
	pOficiFim	Código da Oficina Final
	pEqptoIni	Código Equipamento Inicial
	pEqptofim	Código Equipamento Final
	pEmpIni	Código da Empresa do Equipameto Inicial
	pEmpFim	Código da Empresa do Equipameto Final
	pPlanoIni	Plano Manutenção Inicial
	pPlanoFim	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.

openQueryData

Requisito	A setConstraintData ter sido executada anteriormente.
Sintaxe	run openQueryData in h-handle.
Descrição	Abre a query com os registros por restrição de data de movimento.
	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.

openQueryEqpto

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

criaErrors

Requisito	Nenhum
Sintaxe	run criaErrors in this-procedure (input <integer>).
Descrição	Popula a temp-table de erros principal com os erros da temp auxiliar.
	Parâmetros	Descrição
	RowErrors	Temp-table
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.

criaOrdem

Requisito	Nenhum
Sintaxe	run criaOrdem in h-handle (input <integer>, input <character>, input <integer>, input <character>, input <character>, input <character>, input <character>, input <character>, input <date>).
Descrição	Criação da Ordem de Manutenção Mecânica.
	Parâmetros	Descrição
	pCodEmp	Código da Empresa
	pCodEqpto	Código do Equipamento
	ptipo	Código do tipo de manutenção
	pCodOfici	Código da Oficina
	pCCodigo	Código Centro Custo
	pCodModel	Código Modelo
	pCodPlano	Código Plano
	pCodSetor	Código Setor
	pData	Data Abertura
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.

geraErroOrdem

Requisito	Nenhum.
Sintaxe	run geraErroOrdem in h-handle (input <integer>, input <character>, input <date>, input <character>, input <character>, input <character>, input <table>).
Descrição	Efetua validações para retornar possíveis erros.
	Parâmetros	Descrição
	pCodEmp	Código da Empresa
	pCodEqpto	Código do Equipamento
	pData	Data Programação Manutenção
	pCdofici	Código da Oficina
	pCdPlano	Plano Manutenção
	pCdEvento	Código do Evento
	RowErrors	Temp-Table
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.

geraOrdem

Requisito	Nenhum.
Sintaxe	run geraOrdem in h-handle (input <integer>, input <character>, input <date>, input <character>, input <character>, input <character>).
Descrição	Busca o Calendário para criação da Ordem de Manutenção.
	Parâmetros	Descrição
	pCodEmp	Código da Empresa
	pCodEqpto	Código do Equipamento
	pData	Data Programação Manutenção
	pCdofici	Código da Oficina
	pCdPlano	Plano Manutenção
	pCdEvento	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.

manutMovimentos

Requisito	Nenhum.
Sintaxe	run manutMovimentos in h-handle (input <table>, input <character>).
Descrição	Cria/Modifica os movimentos em batch.
	Parâmetros	Descrição
	RowObject	Temp-table
	pAcao	Ação feita pelo usuário ("ADD", "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.

Árvore de páginas