BOFR029 - Validação, Manutenção e acesso rápido a tabela de Componentes.

Documento de BO

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

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr029.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr029.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 “mco-compon”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
num-seqcial	int	>>>>>>>>9	Número Sequencial dos Componentes	Sim/Key	001
cod-sub-sist	Char	X(8)	Código Sub-Sistema	Sim/Key	001
des-serie	Char	X(20)	Número de Série	Sim	001
cod-compon	Char	X(16)	Código do Componente	Sim/Key	001
cod-model	Char	X(8)	Código do Modelo	Sim	001
des-model	Char	X(30)	Descrição do Modelo	Não	001
cod-localiz-compon	Char	X(15)	Localização Componente	Não	001
dat-inicial	Date	99/99/9999	Início Controle	Sim	001
ep-codigo-inicial	Int	>>9	Código da empresa inicial	Sim	001
cod-eqpto-inicial	Char	X(16)	Código Equipamento Inicial	Sim	001
cod-estabel-inicial	Char	X(3)	Código Estabelecimento Inicial	Sim	001
ep-codigo-atual	Int	>>9	Código da Empresa Atual	Sim	001
cod-eqpto-atual	Char	X(16)	Código Equipamento Atual	Sim	001
val-uso-atual	Decimal	>,>>>,>>9.9	Valor Uso Total do Componente	Sim	001
Cod-estabel-atual	Char	X(3)	Código Estabelecimento Atual	Sim	001
num-vida-inicial	Int	>>9	Vida Inicial	Sim	001
num-vida-atual	Int	>9	Vida Atual	Sim	001
num-vida-histor	Int	>>9	Número vida para início do histórico	Sim	001
cod-sit-compon-inicial	Char	X(8)	Código Situação Inicial Componente	Sim	001
cod-sit-compon-atual	Char	X(8)	Código Situação Componente	Sim	001
dat-situacao	date	99/99/9999	Data da Situação	Não	001
dat-atualiz	date	99/99/9999	Data de Atualização	Não	001
it-codigo	Char	X(16)	Código do Item	Não	001
ct-codigo	Char	X(20)	Código da Conta	Não	001
cc-codigo	Char	X(20)	Código do Centro de Custo	Não	001
dsl-obs	Char	X(800)	Informações Adicionais	Não	001
cod-item-reformad	Char	X(16)	Item Componente Reformado	Sim	001
bm-codigo	Decimal	ZZZ,ZZZ,ZZ9/	Código do bem	Não	001
bm-indice	Int	99999	Indice do bem	Não	001
cod-cta-pat	Char	X(18)	Código da conta patrimonial do Bem	Não	001
cc-codigo-atual	Char	X(20)	Centro Custo Atual	Não	001
ep-codigo	Int	>>9	Código da empresa do componente	Não	001
cod-livre-1	char	x(1000)	Character Livre	Não	001
cod-livre-2	char	x(1000)	Character Livre	Não	001
log-livre-1	log	Sim/Não	Logical Livre	Não	001
log-livre-2	log	Sim/Não	Logical Livre	Não	001
num-livre-1	int	->>>>>>>>>9	Inteiro Livre	Não	001
num-livre-2	int	->>>>>>>>>9	Inteiro Livre	Não	001
val-livre-1	dec	->>>>>>>>>>>9.9	Decimal Livre	Não	001
val-livre-2	dec	->>>>>>>>>>>9.9	Decimal Livre	Não	001
dat-livre-1	date	99/99/9999	Data livre	Não	001
dat-livre-2	date	99/99/9999	Data livre	Não	001
cd-causa-padr	char	x(8)	Causa Desativação Componente
cod-usuar	char	x(12)	Código Usuário

Tabela Temporária

Descrição

Entrada/Saída

RowErrors e

RowErrorsAux

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	001
ErrorNumber	integer	padrão	Número do erro	Sim	001
ErrorDescription	char	padrão	Descrição do erro	Sim	001
ErrorParameters	char	padrão	Parâmetros passados para criar mensagem	Não	001
ErrorType	char	padrão	Tipo do erro: WARNING: Aviso ERROR: Erro	Sim	001
ErrorHelp	char	padrão	Texto de ajuda do erro	Sim	001
ErrorSubType	char	padrão	Sub Tipo da mensagem de erro	Não	001

Métodos

Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

goToKeySubSistema

Requisito	Nenhum
Sintaxe	run goToKeySubSistema in h-handle (input <character>, input <character>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pcod-sub-sist	Código Sub-Sistema
	pcod-compon	Código do Componente
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.

goToKey

Requisito	Nenhum
Sintaxe	run goToKey in h-handle (input <integer>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pnum-seqcial	Número sequencial
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>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pnum-seqcial	Número Sequencial
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

setConstraintCompon

Requisito	Nenhum
Sintaxe	run setConstraintCompon in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query por faixa de código do Componente.
	Parâmetros	Descrição
	pcCodComponIni	Código Componente Inicial
	pcCodComponFim	Código Componente 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 abrir a query por faixa de Descrição do Modelo.
	Parâmetros	Descrição
	pcDesModelIni	Descrição do Modelo inicial
	pcDesModelFim	Descrição do Modelo 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.

setConstraintEquip

Requisito	Nenhum
Sintaxe	run setConstraintEquip in h-handle (input <integer>, input <integer>, input <character>, input <character>).
Descrição	Seta as restrições para abrir a query por faixa de Código da Empresa e Código Equipamento.
	Parâmetros	Descrição
	pEmpIni	Código Empresa Inicial
	pEmpFim	Código Empresa final
	pEqptoIni	Código do Equipamento Inicial
	pEqptoFim	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.

setConstraintFiltro

Requisito	Nenhum
Sintaxe	run setConstraintFiltro in h-handle (input <integer>, input <integer>, input <character>, input <character>).
Descrição	Seta as restrições para abrir a query utilizando o filtro passado.
	Parâmetros	Descrição
	pNumSeqcialIni	Número Sequencial Inicial
	pNumSeqcialFim	Número Sequencial Final
	pSitComponIni	Situação do componente Inicial
	pSitComponFim	Situação do componente 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.

SetConstraintMab-Eqpto

Requisito	Nenhum.
Sintaxe	run setConstraintMab-Eqpto in h-handle (input <integer>, input <character>) .
Descrição	Seta as restrições para abrir a query por faixa de Código da Empresa do Componente e Código do Equipamento.
	Parâmetros	Descrição
	pEpCodigo	Código da Empresa do Componete
	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.

SetConstraintSubSist

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

openQueryCompon

Requisito	A setConstraintCompon ter sido executada anteriormente.
Sintaxe	run openQueryCompon in h-handle.
Descrição	Abre a query da BO conforme a faixa de de Código do Componente passado na procedure setConstraintCompon .
	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.

openQueryComponFiltro

Requisito	A setConstraintCompon ter sido executada anteriormente.
Sintaxe	run openQueryComponFiltro in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do Componente passada na procedure setConstraintCompon.
	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.

openQueryComponFiltroZoom

Requisito	A setConstraintCompon e a setConstraintComponFiltro terem sido executadas anteriormente.
Sintaxe	run openQueryComponFiltroZoom in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do Componente passada na procedure setConstraintCompon e utilizando o filtro passado pela setConstraintComponFiltro.
	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	A setConstraintDescricao ter sido executada anteriormente.
Sintaxe	run openQueryDescricao in h-handle.
Descrição	Abre a query da BO conforme a faixa de Descrição do Componente passada na procedure setConstraintDescricao.
	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.

openQueryDescricaoFiltro

Requisito	A setConstraintDescricao ter sido executada anteriormente.
Sintaxe	run openQueryDescricaoFiltro in h-handle.
Descrição	Abre a query da BO conforme a faixa de Descrição do Componente passada na procedure setConstraintCompon.
	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.

openQueryDescricaoFiltroZoom

Requisito	A setConstraintDescricao e a setConstraintDescricaoFiltro terem sido executadas anteriormente.
Sintaxe	run openQueryDescricaoFiltroZoom in h-handle.
Descrição	Abre a query da BO conforme a faixa de Descrição do Componente passada na procedure setConstraintDescricao e utilizando o filtro passado pela setConstraintDescricaoFiltro.
	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.

openQueryEquip

Requisito	A setConstraintEquip ter sido executada anteriormente.
Sintaxe	run openQueryEqpto in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do Equipamento passada na procedure setConstraintEquip.
	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.

openQueryEquipFiltro

Requisito	A setConstraintEquip ter sido executada anteriormente.
Sintaxe	run openQueryEquipFiltro in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do Equipamento passada na procedure setConstraintEquip.
	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.

openQueryEquipFiltroZoom

Requisito	A setConstraintEquip e a setConstraintEquipFiltro terem sido executadas anteriormente.
Sintaxe	run openQueryEquipFiltroZoom in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do Equipamento passada na procedure setConstraintEquip e utilizando o filtro passado pela setConstraintEquipFiltro.
	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.

openQuerySubSist

Requisito	A setConstraintSubSist ter sido executada anteriormente.
Sintaxe	run openQuerySubSist in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do SubSistema passada na procedure setConstraintSubSist.
	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.

openQuerySubSistFiltro

Requisito	A setConstraintSubSist ter sido executada anteriormente.
Sintaxe	run openQuerySubSistFiltro in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código do SubSistema passada na procedure setConstraintSubSist.
	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.

openQuerySubSistFiltroZoom

Requisito	A setConstraintSubSist e a setConstraintSubSistFiltro terem sido executadas anteriormente.
Sintaxe	run openQuerySubSitFiltroZoom in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código de SubSistema passada na procedure setConstraintsubSist e utilizando o filtro passado pela setConstraintSubSistFiltro.
	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.

OpenQueryMab-Eqpto

Requisito	A setConstraintMab-Eqpto ter sido executada anteriormente.
Sintaxe	run openQueryMab-Eqpto in h-handle.
Descrição	Abre a query da BO conforme a faixa de Código da Empresa e Código do Equipamento passada na procedure setConstraintMab-Eqpto.
	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.

openQueryDefault

Requisito	Nenhum
Sintaxe	run openQueryDefault in h-handle.
Descrição	Realiza a abertura da query da BO.
	Parâmetros	Descrição
	Não Contem
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.

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.

validateEquipamento

Requisito	Ter sido executada alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.
Sintaxe	run validateEquipamento in this-procedure ().
Descrição	Realiza validações nos campos referentes ao equipamento.
	Parâmetros	Descrição
	Nenhum
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.

validateVida

Requisito	Ter sido executada alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.
Sintaxe	run validateVida in this-procedure ().
Descrição	Realiza validações nos campos referentes a vida dos componentes.
	Parâmetros	Descrição
	Nenhum
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.

validateBem

Requisito	Ter sido executada alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.
Sintaxe	run validateBem in this-procedure (input <character>).
Descrição	Realiza integração dos campos relacionados ao bem para o EMS 5 e ou EMS 2
	Parâmetros	Descrição
	pType	Tipo de ação: “CREATE”
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.

buscaVida

Requisito	Nenhum
Sintaxe	run buscaVida in h-handle (input <integer>, input <character>, input <character>, input <integer>).
Descrição	Valida se os componentes tem a vida necessária..
	Parâmetros	Descrição
	pSeq	Código da Sequencia
	pSub	Código do SubSistema
	pComp	Código do Componente
	pVida	Vida
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....

criaGrupoEqptoSubSistema

Requisito	Nenhum
Sintaxe	run criaGrupoEqptoSubSistema in h-handle.
Descrição	Cria relacionamento entre grupo de equipamentos e sub-sistema.
	Parâmetros	Descrição
	Nenhum
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....

criaPlano

Requisito	Nenhum
Sintaxe	run criaPlano in h-handle.
Descrição	Cria os planos do Componente.
	Parâmetros	Descrição
	Nenhum
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....

criaVida

Requisito	Nenhum
Sintaxe	run criaVida in h-handle.
Descrição	Cria as vidas dos componentes.
	Parâmetros	Descrição
	Nenhum
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....

eliminaPlano

Requisito	Nenhum
Sintaxe	run eliminaPlano in h-handle.
Descrição	Elimina registro dos planos do componente.
	Parâmetros	Descrição
	Nenhum
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....

eliminaVida

Requisito	Nenhum
Sintaxe	run eliminaVida in h-handle.
Descrição	Elimina registros da vida do componente.
	Parâmetros	Descrição
	Nenhum
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....

habilitaCampos

Requisito	Nenhum
Sintaxe	run habilitaCampos in h-handle (output<logical>, output<logical>) .
Descrição	Valida de a integração com patrimonio EMS está implatada e se intregração é com EMS 5 ou EMS 2.
	Parâmetros	Descrição
	p-habilita	Habilita campos para ems2 caso param-global.modulo-pt seja yes
	p-ems5	Integração com EMS 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....

linktoMab-Eqpto

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela “mco-compon”.
Sintaxe	run linktoMab-Eqpto in h-handle (input <handle>) .
Descrição	Faz o JOIN entre as tabelas “mco-compon” e “mab-eqpto”.
	Parâmetros	Descrição
	pHandle	Handle da BO “Mab-eqpto”.
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 h-handle.
Descrição	Realiza override após criação de algum registro.
	Parâmetros	Descrição
	Nenhum
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 h-handle.
Descrição	Realiza override após criação de algum registro e cria relacionamento entre o Grupo do equipamento e Sub-Sistema.
	Parâmetros	Descrição
	Nenhum
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....

atualizaDurabilidade

Requisito	Nenhum.
Sintaxe	run atualizaDurabilidade in h-handle.
Descrição	Atualiza o uso atual do Componente.
	Parâmetros	Descrição
	Nenhum
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....

beforeCreateRecord

Requisito	Procedure chamada pelo método interno createRecord. Não deve ser chamada externamente.
Sintaxe	run beforeCreateRecord in h-handle.
Descrição	Realiza override antes da criação de algum registro.
	Parâmetros	Descrição
	Nenhum
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 h-handle.
Descrição	Realiza override antes de eleminar algum registro.
	Parâmetros	Descrição
	Nenhum
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....

beforeUpdateRecord

Requisito	Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.
Sintaxe	run beforeUpdateRecord in h-handle.
Descrição	Realiza override antes de alterar algum registro.
	Parâmetros	Descrição
	Nenhum
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....

setaPrograma

Requisito	Nenhum.
Sintaxe	run setaPrograma in h-handle.
Descrição	Recebe o programa que chamou a BO.
	Parâmetros	Descrição
	pPrograma	Código do programa
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....

setaCopia

Requisito	Nenhum.
Sintaxe	run setaCopia in h-handle.
Descrição	Seta se BO está fazendo uma cópia ou não.
	Parâmetros	Descrição
	pCopia	Ação de cópia
	pAnt	Número sequencial do componente anterior
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....

piRetornaModelo

Requisito	Nenhum
Sintaxe	run piRetornaModelo in handle (input <integer>, output <character>).
Descrição	Retorna o Modelo Utilizado no Cadastro do Componente.
	Parâmetros	Descrição
	piNumSeqcial	Número Sequencial do Componente
	pcCodModel	Código do Modelo
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.

habilitaCamposEMS5

Requisito	Nenhum
Sintaxe	run habilitaCamposEMS5 in handle (output <logical>).
Descrição	Valida se a integração com Patrimônio EMS está implantada.
	Parâmetros	Descrição
	p-habilita	Status da implantação (Yes ou no).
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.

buscaUltimaSequencia

Requisito	Nenhum
Sintaxe	run buscaUltimaSequencia in handle (output <integer>).
Descrição	Retorna a ultima sequencia existente da tabela de componente.
	Parâmetros	Descrição
	piNumSeqcial	Numero seqüencial do componente
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.

piRetornaDataAtualiz

Requisito	Nenhum
Sintaxe	run piRetornaDataAtualiz in handle (input <integer>, output <character>).
Descrição	Retorna a Data de Atualização do Componente.
	Parâmetros	Descrição
	piNumSeqcial	Numero seqüencial do componente
	pdDataAtualiz	Data de Atualização do Componente
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.

piRetornaInfEqpto

Requisito	Nenhum
Sintaxe	run piRetornaInfEqpto in handle (input <character>, input <character>, output <character>, output <character>, output <character>).
Descrição	Retorna informações referente ao Equipamento.
	Parâmetros	Descrição
	pEpCodigo	Código da Empresa
	pCodEqpto	Código do Equipamento
	pCodEstabel	Código do Estabelecimento
	pCodSitEqpto	Código Situação do Equipamento
	pCodUnidNegoc	Código da Unidade de Negó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.

piAcertaCamposLivres

Requisito	Nenhum
Sintaxe	run piAcertaCamposLivres in handle.
Descrição	Realiza a gravação do conteúdo de campos livres nos seus devidos campos criado. Obs.: Executado somente em Metadados.
	Parâmetros	Descrição
	Não Contem
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