Documento de BO

Considerações Gerais

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela portal-reg-clien (Portal Registro do Cliente).

Funcionamento

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 execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.

A sintaxe para executar a BO em modo persistente é:

RUN dibo/bodi00712.p PERSISTENT SET h-bodi00712.

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

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

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 <integer>).
Descrição	Retorna a chave do registro posicionado
	Parâmetros	Descrição
	pidi-seq	Indica a sequencia de identificação da configuração do cliente.
Retorno	A BO irá retornar o valor contido no campo sequencia que foi solicitado a BO.

goToKey
Requisito	Nenhum
Sintaxe	RUN goToKey IN h-handle (INPUT <integer>, INPUT <integer>).
Descrição	Reposiciona registro com base na chave informada
	Parâmetros	Descrição
	pidi-seq	Indica a sequencia de identificação da configuração do cliente.
	pidi-seq-reg	Indica a sequencia de identificação do registro do cliente
Retorno	A BO irá reposicionar no registro que foi solicitado a BO.

validateRecord
Requisito	Nenhum
Sintaxe	RUN validateRecord IN h-handle (INPUT <character>).
Descrição	Efetua as validações do registro antes de ser gravado na tabela de campos do portal
	Parâmetros	Descrição
	pType	Indica o o tipo de gravação do registro (Create, Delete e Update).
Retorno	“OK” – Registro gravado corretamente “NOK” – Registro inválido, Verificar a lista de erros na temp-table RowErrors

returnRecords
Requisito	Nenhum
Sintaxe	RUN returnRecords IN h-handle (INPUT-OUTPUT <character>).
Descrição	Método para retornar o nome da tabela e campo para o label informado
	Parâmetros	Descrição
	p-c-cod-tabela	Nome da tabela para o label informado
Retorno	Retorna os registros para o label informado

assignNumId
Requisito	Nenhum
Sintaxe	run assignNumId in h-handle (input <integer>, output <character>).
Descrição	Método para retornar a sequencia da próxima chave primaria da tabela
	Parâmetros	Descrição
	p-idi-seq-config-clien	Indica a sequencia da configuração do cliente
	p-c-num-id	Retorna a próxima sequencia da tabela
Retorno	Retorna a última sequencia da tabela

verifyControlItem
Requisito	Nenhum
Sintaxe	RUN verifyControlItem IN h-handle (INPUT <character>, OUTPUT <logical>).
Descrição	Método para retornar se o item é controlado por referencia.
	Parâmetros	Descrição
	I_itCodigo	Código do item
	i-controle	Identifica se o item é controlado por referencia
Retorno	Retorna se o item é controlado por referencia.

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

Retorno