Documento de BO

Considerações Gerais

Objetivo

[Faz ...].

Funcionamento

A 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 BO é:

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

input table tt-...,

...,

...).

A execução na forma persistente ...

A sintaxe para executar a 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:

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

goToKey
Requisito	Nenhum
Sintaxe	[nome_método] (input ..., output ..., ..., ...)
Descrição	Reposiciona registro com base no código do tanque
	Parâmetros	Descrição
	Pcod-tanque	Código Tanque
Retorno	A 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.... As mensagens possíveis para este método são....

getKey
Requisito
Sintaxe
Descrição	Retorna valores dos campos do código do tanque
	Parâmetros	Descrição
	Pcod-tanque	Código Tanque
Retorno

getCharField
Requisito
Sintaxe
Descrição	Retorna o valor de um campo character.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

getDecField
Requisito
Sintaxe
Descrição	Retorna o valor de um campo decimal.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

getIntField
Requisito
Sintaxe
Descrição	Retorna o valor de um campo inteiro.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

getDateField
Requisito
Sintaxe
Descrição	Retorna o valor de um campo date.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

getLogField
Requisito
Sintaxe
Descrição	Retorna o valor de um campo logical.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

getRawField
Requisito
Sintaxe
Descrição	Retorna valor de campos do tipo raw.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

getRecidField
Requisito
Sintaxe
Descrição	Retorna valor de campos do tipo recid.
	Parâmetros	Descrição
	pFieldName pFieldValue	Nome Campo Valor Campo
Retorno

linkToagrup-tanque
Requisito
Sintaxe
Descrição	Configura pesquisa com a tabela de Agrupamentos com Tanques.
	Parâmetros	Descrição
	p-h-bo-agrup-tanque	Ponteiro para tabela Agrup-tanque
Retorno

buscaEstab
Requisito
Sintaxe
Descrição	Busca estabelecimento da área de produção informada.
	Parâmetros	Descrição
	p-cod-area-produc p-cod-estab	Código área de produção Código estabelecimento
Retorno

OpenQueryStatic ("Main")
Requisito
Sintaxe
Descrição	Busca conjunto de registros da tabela tanque.
	Parâmetros	Descrição

Retorno

OpenQueryStatic ("AgrupTanque")
Requisito
Sintaxe
Descrição	Busca conjunto de registros da tabela tanque com base no valor recebido pela agrup-tanque.
	Parâmetros	Descrição

Retorno

OpenQueryStatic ("FiltroTanque")
Requisito
Sintaxe
Descrição	Busca conjunto de registros da tabela tanque com base em um tanque inicial e um tanque final.
	Parâmetros	Descrição

Retorno

OpenQueryStatic ("TipoTanque")
Requisito
Sintaxe
Descrição	Busca conjunto de registros da tabela tanque com base no código do tanque e seu tipo (aca, pro ou ambos).
	Parâmetros	Descrição

Retorno

SetConstraintAgrup
Requisito
Sintaxe
Descrição	Seta as variáveis de controle para queries contendo o código do agrupamento.
	Parâmetros	Descrição
	p-tip-tanque	Código Tanque
Retorno