BOFR129 - Validação, Manutenção e acesso rápido a tabela de Características do Componente.

Documento de BO

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

Objetivo

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

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr129.p.

A execução na forma persistente.

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr129.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-caract”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
num-seqcial	Int	>>>>>>>>9	Numero Sequencial dos Componentes	Sim
cod-caract	Char	x(8)	Código da Característica	Sim
des-caract	Char	x(30)	Descrição da Característica	Não
des-arquivo	Char	x(50)	Nome do Arquivo Relacionado	Não
cod-livre-1	Char	x(100)	Character Livre	Não
cod-livre-2	Char	x(100)	Character Livre	Não
log-livre-1	Log	Sim/Não	Logical Livre	Não
log-livre-2	Log	Sim/Não	Logical Livre	Não
num-livre-1	Int	- >>>>>>>>9	Inteiro Livre	Não
num-livre-2	Inte	->>>>>>>>9	Inteiro Livre	Não
val-livre-1	Dec	->>>>>>>>>>>9.9999	Decimal Livre	Não
val-livre-2	Dec	->>>>>>>>>>>9.9999	Decimal Livre	Não
dat-livre-1	Date	99/99/9999	Data Livre	Não
dat-livre-2	Date	99/99/9999	Data Livre	Não

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

Tabela Temporária	Descrição	Entrada/Saída
ttCaractComponAux	Tabela temporária “ttCaractComponAux”

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-caract	Char	x(8)	Código da Característica	Não
des-caract	Char	x(30)	Descrição da Característica	Não
des-arquivo	Char	x(50)	Nome do Arquivo Relacionado	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>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pnum-seqcial	recebe valor do campo num-seqcial
	pcod-caract	recebe valor do campo cod-caract
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>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pnum-seqcial	recebe valor do campo num-seqcial
	pcod-caract	recebe valor do campo cod-caract
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.

OpenQuery / SetConstraint / LinkTo

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.

buscaCatalogo

Requisito	Nenhum
Sintaxe	run buscaCatalogo in h-handle (input <character>, output <logical>).
Descrição	Retorna se a característica possui catálogo de documento.
	Parâmetros	Descrição
	pcod-caract	Código da Característica
	p-ok	Variável lógica de retorno
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.

piAddCaractCompon

Requisito	Nenhum
Sintaxe	run piAddCaractCompon in h-handle (input <integer>, input <character>, input <character>, input <character>, output <temp-table>).
Descrição	Realizar a gravação da tabela “mco-compon-caract” com base nas informações recebidas por parâmetros.
	Parâmetros	Descrição
	pNumSeqcial	Numero Sequencial do Componente
	pCodCaract	Código da característica
	pDesCaract	Descrição da característica
	pDesArquivo	Descrição do Arquivo relacionado a característica
	RowErrors	Temp-table com os erros de gravação. (Ver definição de Temp-table no início desse documento)
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.

piUpdateCaractCompon

Requisito	Nenhum
Sintaxe	run piUpdateCaractCompon in h-handle (input <integer>, input <character>, input <character>, input <character>, output <temp-table>).
Descrição	Realizar a alteração da tabela “mco-compon-caract” com base nas informações recebidas por parâmetros.
	Parâmetros	Descrição
	pNumSeqcial	Numero Sequencial do Componente
	pCodCaract	Código da característica
	pDesCaract	Descrição da característica
	pDesArquivo	Descrição do Arquivo relacionado a característica
	RowErrors	Temp-table com os erros de gravação. (Ver definição de Temp-table no início desse documento)
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.

piGetCaractCompon

Requisito	Nenhum
Sintaxe	run piGetCaractCompon in h-handle (input <integer>, output <temp-table>).
Descrição	Retorna as Características do Componente.
	Parâmetros	Descrição
	pNumSeqcial	Numero Sequencial do Componente
	ttCaractComponAux	Temp-table com as características do componente (Ver definição de Temp-table no início desse documento)
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.

piGetInfCaractCompon

Requisito	Nenhum
Sintaxe	run piGetInfCaractCompon in h-handle (input <integer>, input <character>, output <character>, output <character>).
Descrição	Retorna informações da Característica do componente.
	Parâmetros	Descrição
	pNumSeqcial	Numero Sequencial do Componente
	pCodCaract	Código da Característica
	pDesCaract	Descrição da Característica do Componente
	pDesArquivo	Descrição do Arquivo realizado a Característica
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.

piDelCaractCompon

Requisito	Nenhum
Sintaxe	run piDelCaractCompon in h-handle (input <integer>, input <character>, output <temp-table>).
Descrição	Realizar a exclusão da tabela “mco-compon-caract” com base nas informações recebidas por parâmetros.
	Parâmetros	Descrição
	pNumSeqcial	Numero Sequencial do Componente
	pCodCaract	Código da característica
	RowErrors	Temp-table com os erros de gravação. (Ver definição de Temp-table no início desse documento)
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