Documento de BO

Considerações Gerais

Objetivo

[Faz ...].

Funcionamento

A API/BO...

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API/BO é:

run xxx/xxapinnn.p (input-output table tt-...,

input table tt-...,

...,

...).

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

run xxx/xxapinnn.p persistent set h-handle (input-output table tt-...,

input table tt-...,

...,

...).

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

tt-balan-usuar					Entrada/Saída
Relacionamento Balança x Usuário x Estabelecimento					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-balanca	character	x(12)	Balança	Sim
cod-estabel	character	x(05)	Estabelecimento	Sim
cod-usuar	character	x(12)	Usuário	Sim
val-perc-variac-amaior	decimal	>>9.99	Perc Var a Maior	Não
val-perc-variac-amenor	decimal	->>9.99	Perc Var a Menor	Não
log-principal	logical	Sim/Não	Relac Principal?	Não
log-peso-manual	logical	Sim/Não	Pesagem Principal?	Não
log-peso-contingen	logical	Sim/Não	Pesagem Contigência	Não
cod-usuar-alter	character	x(12)	Usuário Ult Alt	Não
dat-ult-alter	date	99/99/9999	Dt Última Alteração	Não
hra-ult-alter	character	x(20)	Hora Última Alteração	Não
cod-livre-1	character	x(100)	Livre 1	Não
cod-livre-2	character	x(500)	Livre 2	Não
log-livre-1	logical	Sim/Não	Livre 1	Não
log-livre-2	logical	Sim/Não	Livre 2	Não
num-livre-1	integer	>>>>>>>>9	Livre 1	Não
num-livre-2	integer	>>>>>>>>9	Livre 2	Não
val-livre-1	decimal	->>>>>>>>>>>9.99999999	Livre 1	Não
val-livre-2	decimal	->>>>>>>>>>>9.99999999	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

getCharField
Requisito	Nenhum
Sintaxe	RUN getCharField IN handle (INPUT <character>, OUTPUT <character>).
Descrição	Retorna valor dos campos do tipo caracter
	Parâmetros	Descrição
	pFieldName	Nome do campo caracter que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo caracter que foi solicitado a BO.

getDateField
Requisito	Nenhum
Sintaxe	RUN getDateField IN handle (INPUT <character>, OUTPUT <date>).
Descrição	Retorna valor dos campos do tipo data
	Parâmetros	Descrição
	pFieldName	Nome do campo data que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo data que foi solicitado a BO.

getDecField
Requisito	Nenhum
Sintaxe	RUN getDecField IN handle (INPUT <character>, OUTPUT <decimal>).
Descrição	Retorna valor dos campos do tipo decimal
	Parâmetros	Descrição
	pFieldName	Nome do campo decimal que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo decimal que foi solicitado a BO.

getIntField
Requisito	Nenhum
Sintaxe	RUN getIntField IN handle (INPUT <character>, OUTPUT <integer>).
Descrição	Retorna valor dos campos do tipo inteiro
	Parâmetros	Descrição
	pFieldName	Nome do campo inteiro que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo inteiro que foi solicitado a BO.

getLogField
Requisito	Nenhum
Sintaxe	RUN getLogField IN handle (INPUT <character>, OUTPUT <logical>).
Descrição	Retorna valor dos campos do tipo logico
	Parâmetros	Descrição
	pFieldName	Nome do campo logico que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo logico que foi solicitado a BO.

getRawField
Requisito	Nenhum
Sintaxe	RUN getRawField IN handle (INPUT <character>, OUTPUT <raw>).
Descrição	Retorna valor dos campos do tipo raw
	Parâmetros	Descrição
	pFieldName	Nome do campo raw que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo raw que foi solicitado a BO.

getRecidField
Requisito	Nenhum
Sintaxe	RUN getRecidField IN handle (INPUT <character>, OUTPUT <recid>).
Descrição	Retorna valor dos campos do tipo recid
	Parâmetros	Descrição
	pFieldName	Nome do campo recid que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo recid que foi solicitado a BO.

getKey
Requisito	Nenhum
Sintaxe	RUN getKey IN handle (OUTPUT <character>, OUTPUT <character>, OUTPUT <character>).
Descrição	Retorna valor do campo do índice blnsr_id2
	Parâmetros	Descrição
	pcod-balanca	Balança
	pcod-estabel	Estabelecimento
	pcod-usuar	Usuário
Retorno	A BO irá retornar o valor contido no campo ordem de pesagem e no campo sequencia do registro que foi solicitado a BO.

goToKey
Requisito	Nenhum
Sintaxe	RUN goToKey IN h-handle (INPUT <character>, INPUT <character>, INPUT <character>).
Descrição	Reposiciona registro com base no índice blnsr_id2
	Parâmetros	Descrição
	pcod-balanca	Balança
	pcod-estabel	Estabelecimento
	pcod-usuar	Usuário
Retorno	A BO irá reposicionar no registro que foi solicitado a BO.

openQueryMain
Requisito	Nenhum
Sintaxe	run openQueryStatic in h-handle (input "Main":U).
Descrição	Faz a abertura da tabela principal.
	Parâmetros	Descrição

Retorno

openQueryUsuar
Requisito	Nenhum
Sintaxe	run openQueryStatic in h-handle (input “Usuar”).
Descrição	Faz a abertura da tabela principal pelo usuário
	Parâmetros	Descrição

Retorno

openQueryBalanca
Requisito	Nenhum
Sintaxe	run openQueryStatic in h-handle (input “Balanca”).
Descrição	Faz a abertura da tabela principal pela balança
	Parâmetros	Descrição

Retorno

setConstraintUsuar
Requisito	Nenhum
Sintaxe	run setConstraintUsuar in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abertura da query pelo usuário
	Parâmetros	Descrição
	p-cod-usuar-ini	Usuário inicial
	p-cod-usuar-fim	Usuário final
Retorno

setConstraintBalanca
Requisito	Nenhum
Sintaxe	run setConstraintBalanca in h-handle (input <character>, input <character>, input <character>).
Descrição	Seta as restrições para abertura da query pela balança
	Parâmetros	Descrição
	p-cod-balanca	Balança
	p-cod-estabel	Estabelecimento
	p-cod-usuar	Usuário
Retorno