Documento de BO

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

Considerações Gerais

Objetivo

Tratamento da regra de negócio da tabela crm_configur_acao_ocor_regra.

Funcionamento

A BO possibilita tratamento e validação da regra de negócio. 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 do BO é:

run crmbo/boCrmConfigurAcaoOcorRegra.p

A sintaxe para executar o BO em modo persistente é:

run crmbo/boCrmConfigurAcaoOcorRegra.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 API.

Tabelas Temporárias

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

RowObject					Entrada/Saída
Tabela temporária padrão para BO’S, sua definição é “like” , ou seja, possuí todos os campos da tabela física utilizada na geração da bo, mais o campo r-rowid do to tipo rowid.					Ver método básico e método de negócio
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Num_id	Int	99999999	Chave primáia	Sim
num_id_configur_acao_ocor	Int	99999999	Configuração do registro de ação na ocorrência	Sim
idi_atrib_ocor	Int	9	Tipo de atributo	Sim
Num_id_atrib_regra	Int	9	Valor do atributo	Sim
num_livre_1	Int	99999999	Campo livre 1	Não
num_livre_2	Int	99999999	Campo livre 2	Não
cdd_version	Dec	zzz,zzz,zz9.9	Controle de versão da alteração	Não
val_livre_1	Dec	zzz,zzz,zz9.9	Campo livre 1	Não
val_livre_2	Dec	zzz,zzz,zz9.9	Campo livre 2	Não
dat_livre_1	Data	99/99/9999	Campo livre 1	Não
dat_livre_2	Data	99/99/9999	Campo livre 2	Não
dat_timestamp	Data	99/99/9999	Data hora alteração	Não
cod_livre_1	Char	X(100)	Campo livre 1	Não
cod_livre_2	Char	X(100)	Campo livre 2	Não
log_livre_1	Log	Yes/no	Campo livre 1	Não
log_livre_2	log	Yes/no	Campo livre 2	não

Método Básico

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

getCharField
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	getCharField in h-handle (input pFieldName, output pFieldValue).
Descrição	Método usado para retornar valores de campos do tipo caracter para a tabela Crm_configur_acao_ocor_regra.
	Parâmetros	Descrição
	pFieldName	Nome do campo para retornar o valor (character).
	pFieldValue	Valor do campo solicitado (character).
Retorno	A BO irá setar o parâmetro de output de forma a informar ao programa “chamador” o valor daquele campo para o registro posicionado pela BO. Os Erros serão tratados temp-table RowErrors.

getIntField
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	getCharField in h-handle (input pFieldName, output pFieldValue).
Descrição	Método usado para retornar valores de campos do tipo inteiro para a tabela Crm_configur_acao_ocor_regra.
	Parâmetros	Descrição
	pFieldName	Nome do campo para retornar o valor (character).
	pFieldValue	Valor do campo solicitado (integer).
Retorno	A BO irá setar o parâmetro de output de forma a informar ao programa “chamador” o valor daquele campo para o registro posicionado pela BO. Os Erros serão tratados temp-table RowErrors

getDecField
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	getCharField in h-handle (input pFieldName, output pFieldValue).
Descrição	Método usado para retornar valores de campos do tipo Decimal para a tabela Crm_configur_acao_ocor_regra.
	Parâmetros	Descrição
	pFieldName	Nome do campo para retornar o valor (character).
	pFieldValue	Valor do campo solicitado (Decimal).
Retorno	A BO irá setar o parâmetro de output de forma a informar ao programa “chamador” o valor daquele campo para o registro posicionado pela BO. Os Erros serão tratados temp-table RowErrors.

getDateField
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	getCharField in h-handle (input pFieldName, output pFieldValue).
Descrição	Método usado para retornar valores de campos do tipo Data para a tabela Crm_configur_acao_ocor_regra.
	Parâmetros	Descrição
	pFieldName	Nome do campo para retornar o valor (character).
	pFieldValue	Valor do campo solicitado (Date).
Retorno	A BO irá setar o parâmetro de output de forma a informar ao programa “chamador” o valor daquele campo para o registro posicionado pela BO. Os Erros serão tratados temp-table RowErrors.

getLogField
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	getCharField in h-handle (input pFieldName, output pFieldValue).
Descrição	Método usado para retornar valores de campos do tipo Lógico para a tabela Crm_configur_acao_ocor_regra
	Parâmetros	Descrição
	pFieldName	Nome do campo para retornar o valor (character).
	pFieldValue	Valor do campo solicitado (Logical).
Retorno	A BO irá setar o parâmetro de output de forma a informar ao programa “chamador” o valor daquele campo para o registro posicionado pela BO. Os Erros serão tratados temp-table RowErrors.

getKey
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	getKey in h-handle (output pnum_id).
Descrição	Método usado para retornar o valor do identificador seqüencial da tabela crm_configur_acao_ocor_regra.
	Parâmetros	Descrição
	pnum_id	Identificador seqüencial (integer).
Retorno	A BO irá setar o parâmetro de output de forma a informar ao programa “chamador” o valor do campo usado como identificador seqüencial para o registro posicionado pela BO. Os Erros serão tratados temp-table RowErrors.

goToKey
Requisito	Executar a BO persistente.
Sintaxe	goToKey in h-handle (input pnum_id).
Descrição	Método usado para posicionar a BO em um determinado registro, de acordo identificador seqüencial da tabela crm_configur_acao_ocor_regra.
	Parâmetros	Descrição
	pnum_id	Identificador seqüencial (integer).
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 Erros serão tratados temp-table RowErrors.

validateRecord
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	validateRecord in h-handle (input pType).
Descrição	Método usado para efetuar as devidas validações ao adicionar, atualizar ou remover um registro da tabela. este é executado automáticamente pela BO sempre que executar um dos métodos padrões(createRecord, updateRecord, deleteRecord).
	Parâmetros	Descrição
	pType	Tipo de operação (character) “create,update or delete”.
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 Erros serão tratados na temp-table RowErrors.

Método Negócio

validateRegra
Requisito	Executar a BO persistente e estar previamente posicionado em um registro.
Sintaxe	validateRegra in h-handle (input pNumId, input pNumIdConfigurAcaoOcor, input pIdiAtribOcor).
Descrição	Método usado para validar se ao salvar a operação de inclusão ou alteração verificar se na regra que está sendo criada já existe um registro com o mesmo atributo informado, caso exista informar ao usuário que não é permitido informar mais de uma vez o mesmo atributo.
	Parâmetros	Descrição
	pNumId	Identificador (integer).
	pNumIdConfigurAcaoOcor	Identificador da configuração (integer).
	pIdiAtribOcor	Tipo de atributo (integer).
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 Erros serão tratados na temp-table RowErrors, caso haja erro será adicionado a mensagem de erro com código 52887.

OpenQuery / SetConstraint / LinkTo

OpenQueryStatic
Requisito	Executar a BO persistente.
Sintaxe	run openQueryStatic in h-handle (input “Default”).
Descrição	Seta as restrições para abertura da query, no caso da opção default não há restrições.
	Parâmetros	Descrição
	-	-
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).

Árvore de páginas

boCrmConfigurAcaoOcorRegra - Manter regras para registro de ação genérico para ocorrências