BOFR008 - Método de acesso e manutenção a tabela de Relacionamento Grupo Equipamento x Sub Sistema.

Documento de BO

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

Objetivo

Validação, Manutenção e acesso rápido a tabela “mab-eqpto-sub-sist”.

Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mab-eqpto-sub-sist”.

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

A sintaxe para a chamada BO é:

run frbo\bofr008.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr008.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 “mab-eqpto-sub-sist”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-grp-eqpto	Char	X(8)	Código do Grupo de Equipamentos	Sim
cod-sub-sist	char	X(8)	Código do Sub Sistema	Sim
qti-max	Int	>>9	Quantidade Máxima	Sim
cod-livre-1	char	X(100)	Livre 1
cod-livre-2	char	X(100)	Livre 2
log-livre-1	Log	Sim/Não	Livre 1
log-livre-2	Log	Sim/Não	Livre 2
num-livre-1	Int	->>>>>>>>>9	Livre 1
num-livre-2	Int	->>>>>>>>>9	Livre 2
val-livre-1	Dec	->>>>>>>>>>>9.9999	Livre 1
val-livre-2	Dec	->>>>>>>>>>>9.9999	Livre 2
dat-livre-1	date	99/99/9999	Livre 1
dat-livre-2	date	99/99/9999	Livre 2
val-uso-estimad	Dec	>>,>>>,>>9.9	Uso Estimado
num-dias-estimad	Integer	>>,>>9	Número Dias Estimados
val-km-aviso	Dec	>>,>>>,>>9	Antecipação para troca
num-dias-antecip	Integer	>9	Número de dias de antecipação
val-km-hora-gartia	Dec	>,>>>,>>9.9	Indica a Garantia, de acordo com a unidade
num-dias-gartia	Integer	>,>>9	Número de dias do prazo de garantia

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>).
Descrição	Reposiciona o registro doGrupo de Equipamento X Sub Sistema através do código do grupo de equipamentos e do código do Sub Sistema.
	Parâmetros	Descrição
	cod-grp-eqpto	Código do Grupo de Equipamentos
	cod-sub-sist	Código do Sub Sistema
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>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	cod-grp-eqpto	Código do Grupo de Equipamentos
	cod-sub-sist	Código do Sub Sistema
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

LinkTomab-grp-eqpto

Requisito	Posicionar a query do BO de mab-grp-eqpto no registro desejado.
Sintaxe	run linkTomab-grp-eqpto in h-handle (input <hanlde>).
Descrição	Seta as variáveis de controle para criar o linkTo com a tabela pai “mab-grp-eqpto” contendo o campo cod-grp-eqpto.
	Parâmetros	Descrição
	pHandle	Handle BO da tabela mab-grp-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 RowErrors.

setConstraintCodSubSist

Requisito	Nenhum
Sintaxe	run setConstraintCodSubSist in h-handle (input <character>, input <character>).
Descrição	Carrega as variável com uma faixa inicial e final do código do sub sistema para openQueryCodSubSist.
	Parâmetros	Descrição
	pCdSubSistIni	Código do sub sistema inicial
	pCdSubSistFim	Código do sub sistema 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.

setConstraintGrpEqpto

Requisito	Nenhum
Sintaxe	run setConstraintGrpEqpto h-handle (input <character>, input <character>).
Descrição	Carrega as variável com uma faixa inicial e final do código do grupo de equipamentos para openQueryGrpEqpto.
	Parâmetros	Descrição
	pCdGrpIni	Código do Grupo de Equipamentos inicial
	pCdGrpFim	Código do Grupo de Equipamentos 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.

setConstraintSubSistxGrp

Requisito	Nenhum
Sintaxe	run setConstraintSubSistxGrp in h-handle (input <character>, input <character>, input <character>).
Descrição	Carrega as variável com uma faixa inicial e final do código do sub sistema mais o código do grupo de equipamentos para openQuerySubSistxGrp.
	Parâmetros	Descrição
	pCdSubSistIni	Código do sub sistema inicial
	pCdSubSistFim	Código do sub sistema final
	pGrpEqpto	Código do Grupo de Equipamentos
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.

setConstraintGrupo

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

openQueryMain

Requisito	Nenhum.
Sintaxe	run openQueryMain in h-handle.
Descrição	Busca conjunto de registros da tabela mab-eqpto-sub-sist. Os registros são ordenados pelo código do grupo de equipamentos e código do 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 RowErrors.

openQueryCodSubSist

Requisito	Executar o método setConstraintCodSubSist.
Sintaxe	run openQueryCodSubSist in h-handle.
Descrição	Busca conjunto de registros da tabela mab-eqpto-sub-sist com base em uma faixa inicial e final do código do sub sistema. Os registros são ordenados pelo código do 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 RowErrors.

openQueryGrpEqpto

Requisito	Executar os métodos setConstrainGrpEqpto.
Sintaxe	run openQueryGrpEqpto in h-handle.
Descrição	Busca conjunto de registros da tabela mab-eqpto-sub-sist com base em uma faixa inicial e final do código do grupo de equipamento. Os registros são ordenados pelo código do grupo de equipamento.
	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-grp-eqpto

Requisito	Nenhum
Sintaxe	run openQuerymab-grp-eqpto in h-handle.
Descrição	Busca conjunto de registros da tabela mab-eqpto-sub-sist com base nos registros retornados pelo método likTomab-grp-eqpto. Os registros são ordenados pelo código do grupo de equipamentos.
	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.

openQuerySubSistxGrp

Requisito	Executar os métodos setConstraintSubSistxGrp.
Sintaxe	run openQuerySubSistxGrp in h-handle.
Descrição	Busca conjunto de registros da tabela mab-consu-model com base em uma faixa inicial e final do código do sub sistema mais o código do grupo de equipamentos. Os registros são ordenados pelo código do sub sistema e pelo código do grupo de equipamentos.
	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.

CopiaGrupoSub

Requisito	Nenhum
Sintaxe	run CopiaGrupoSub in h-handle (input <character>, input <character>, input <logical>).
Descrição	Copia de TempoPadrao do Modelo.
	Parâmetros	Descrição
	pigrupoOrigem	grupo Origem
	pigrupoDestino	grupo Destino
	piSobrepor	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....

CopiaGrupoSubMetaDados

Requisito	Nenhum
Sintaxe	run CopiaGrupoSubMetaDados in h-handle (input <character>, input <character>, input <logical>, output <RowErros>).
Descrição	Copia de TempoPadrao do Modelo.
	Parâmetros	Descrição
	pigrupoOrigem	grupo Origem
	pigrupoDestino	grupo Destino
	piSobrepor	Sim/Não
	RowErrors	Temp-table RowErrors
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