Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	dibo/bodi594.p

Objetivo

Criação, Validação, Manutenção e acesso rápido a tabela “fatur-repres-item”

Funcionamento

A BO irá criar, validar os dados, manutenir as tabelas e fazer a leitura dos registros da tabela “fatur-repres-item”

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

A sintaxe para a chamada BO é:

run dibo\bodi594.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run dibo\bodi594.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 “fatur-repres-item”.	Entrada/Saída

Atributo		Tipo	Formato	Descrição	Obrigatório		Evolução
Cod-estabel		Char	x(5)	Código do Estabelecimento	Sim
Cod-serie		char	x(5)	Série	Sim
Nr-fatura		Char	X(16)	Nr Fatura	Sim
Nome-ab-rep		char	X(12)	Representante	Sim
perc-comis		dec	>>9.999	% Comissao	Sim
val-base-calc-comis		dec	>>>,>>>,>>>,>>9.99	Base Cálculo Comissão	Não
idi-tip-comis-agent		int	9	Tipo Comissão Agente	Sim
idi-tip-base-comis-agent		Int	9	Tipo Base Comis Agente	Sim
It-codigo		char	X(16)	Item	Sim
cod-livre-1		char	X(100)	Livre 1	Não
cod-livre-2		char	X(100)	Livre 2	Não
log-livre-1		Log	Sim/Não	Livre 1	Não
log-livre-2		Log	Sim/Não	Livre 2	Não
num-livre-1		Int	->>>>>>>>>9	Livre 1	Não
num-livre-2		Int	->>>>>>>>>9	Livre 2	Não
val-livre-1		Dec	->>>>>>>>>>>9.9999	Livre 1	Não
val-livre-2		Dec	->>>>>>>>>>>9.9999	Livre 2	Não
dat-livre-1		date	99/99/9999	Livre 1	Não
dat-livre-2		date	99/99/9999	Livre 2	Não
cod-classificador		char	X(08)	Cod Classificador	Sim
Val-comis		Dec	->>>,>>>,>>>,>>9.9999	Valor Comissão	Não
val-perc-comis-emis		dec	>>9.99	% Comis Emis	Não
val-comis-emis		Dec	>>9.99999999	Comissão Emissão	Não
idi-liber-pagto-comis-agent		Int	9	Liberação Pagto Comiss	Não
Des-checksum		char	X(20)	Check -sum	Não
num-seq		dec	>>,>>9	Nr Sequência	Sim
cod-refer		char	X(08)	Referência	Sim

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>).
Descrição	Reposiciona a query com base na chave primária da tabela. DEFINE INPUT PARAMETER pcod-estabel LIKE fatur-repres-item.cod-estabel NO-UNDO. DEFINE INPUT PARAMETER pcod-serie LIKE fatur-repres-item.cod-serie NO-UNDO. DEFINE INPUT PARAMETER pnr-fatura LIKE fatur-repres-item.nr-fatura NO-UNDO. DEFINE INPUT PARAMETER pnome-ab-rep LIKE fatur-repres-item.nome-ab-rep NO-UNDO. DEFINE INPUT PARAMETER pit-codigo LIKE fatur-repres-item.it-codigo NO-UNDO. DEFINE INPUT PARAMETER pcod-classificador LIKE fatur-repres-item.cod-classificador NO-UNDO.
	Parâmetros	Descrição
	pcod-estabel pcod-serie pnr-fatura pnome-ab-rep pit-codigo pcod-classificador	Código do Estabelecimento Série Número da Fatura Representante Código do Item Código Classificador
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>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pcod-estabel pcod-serie pnr-fatura	Código do Estabelecimento Série Número da Fatura
	pnome-ab-rep	Representante
	pit-codigo	Código do Item
	pcod-classificador	Código classificador
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

Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura) utilizadas para buscar grupos de registros da base de dados.

setConstraintByFaturRepresItem

Requisito	Nenhum
Sintaxe	run setConstraintByFaturRepresItem in h-handle (input <character>, input <character>).
Descrição	Carrega a tabela fatur-repres-item para openQueryByFaturRepresItem.
	Parâmetros	Descrição
	pcod-estabel pcod-serie pnr-fatura pnome-ab-rep pit-codigo pcod-classificador	Código do Estabelecimento Série Número da Fatura Representante Código do Item Código Classificador

openQueryStatic(“Main”)

Requisito	Nenhum
Sintaxe	run openQueryMain in h-handle.
Descrição	Busca conjunto de registros da tabela fatur-repres-item

openQueryByFaturRepresItem

Requisito	Nenhum
Sintaxe	run openQueryByFaturRepresItem in h-handle.
Descrição	Busca conjunto de registros da tabela fatur-repres-item.

Método Negócio

PROCEDURE criaFaturRepresItem

Descrição

Cria registro na tabela fatur-repres-item.

DEF INPUT PARAM p-i-seq-wt-docto LIKE wt-docto.seq-wt-docto NO-UNDO.

DEF INPUT PARAM p-rw-nota-fiscal AS ROWID NO-UNDO.

PROCEDURE criaFatRepre