Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

boCrmCampanha.p

 

RecordSet

Temp-Table principal usada para utilização dos métodos da BO e suas respectivas definiçõesRecordSet

RowObject

Atributo

Tipo

Formato

        Descrição

Obr.

num_id

int

99999999

Código identificador seqüencial

Sim 

Num_id_template

int

9

Template

Não

Log_template

log

Sim/Não

Gerar Template

Não

Nom_campanha

Char

X(40)

Campanha

Sim

Dsl_campanha

Char

X(400)

Descrição da Campanha

Não

Dat_inic

Date

99/99/9999

Início

Sim

Dat_term

Date

99/99/9999

Término

Não

Val_acao

Dec

->>,>>>,>>>,>>9.99

Custos das Ações

Não

Val_adc_campanha

Dec

->>,>>>,>>>,>>9.99

Custos da Campanha

Não

Val_tot_cust_previs

Dec

->>,>>>,>>>,>>9.99

Custo Total Previsto

Não

Dsl_motivo

Char

X(1500)

Motivo (Quitação de Tarefas)

Não

Dat_timestamp

Date

99/99/9999

Data de Alteração do Registro

Sim

Cdd_version

Dec

>>>,>>>,>>>,>>9

Versão

Não

Num_id_tip_campanha

Int

>>>>,>>9

Id Tipo Campanha

Sim

Log_finaliza

Log

Sim/Não

Finaliza

Não

Num_livre_1

Int

>>>>>9

Livre 1

Não

Val_livre_1

Dec

Zzz,zzz,zz9.9999

Livre 1

Não

Val_livre_2

Dec

Zzz,zzz,zz9.9999

Livre 2

Não

Num_livre_2

Int

>>>>>9

Livre 2

Não

Cod_livre_1

Char

X(100)

Livre 1

Não

Cod_livre_2

Char

X(100)

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

Log_livre_1

Log

Sim/Não

Livre 1

Não

Log_livre_2

Log

Sim/Não

Livre 2

Não

 

Métodos Básicos

Métodos básicos de acesso ao banco de dados.

 

Método: goToKey

Descrição: Reposiciona registro com base no índice CODIGO

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

Num_id

Int

99999999

X

 

 

Código identificador seqüencial

 

Método: getKey 

Descrição: Retorna valores dos campos do índice CODIGO

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

Num_id

Int

99999999

 

X

 

Código identificador seqüencial

 

Método: validateRecord 

Descrição:

             Valida temptable RowObject.

Em caso de Criação ou Alteração do registro:

  • Valida se o nome da campanha já foi cadastrado.
  • Valida se a data inicial é menor que a data final, casa exista a data final.
  • Valida se a data de término é maior que data atual, caso o flag log_finaliza esteja selecionado.

Em caso de Eliminação do registro:

  • Caso exista registro relacionado na tabela CRM_CAMPANHA_ACAO, o registro de Campanha não é eliminado.

Requisitos: Nenhum

Parâmetros: Recebe o tipo de validação (Create, Delete, Update)

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pType

char

 

X

 

 

Recebe o tipo de validação

 

Método: getCharField

Descrição: Retorna o valor de um campo character.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

char

 

 

X

 

Valor Campo

 

Método: getDecField

Descrição: Retorna o valor de um campo decimal.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

char

 

 

X

 

Valor Campo

 

Método: getIntField

Descrição: Retorna o valor de um campo inteiro.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

char

 

 

X

 

Valor Campo

 

Método: getDateField

Descrição: Retorna o valor de um campo date.

Requisitos: Nenhum

Parâmetros: 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

char

 

 

X

 

Valor Campo

 

Método: getLogField

Descrição: Retorna o valor de um campo logical.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

char

 

 

X

 

Valor Campo

 

Método: getRawField

Descrição: Retorna valor de campos do tipo raw.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

raw

 

 

X

 

Valor Campo

 

Método: getRecidField

Descrição: Retorna valor de campos do tipo recid.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pFieldName

char

 

X

 

 

Nome Campo

pFieldValue

recid

 

 

X

 

Valor Campo

 

Queries e Constraints

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

 

Método: openQueryDefault 

Descrição: Método padrão para abertura da query.

 

Métodos Negócio

Métodos adicionais de atualização e acesso a base de dados .

 

Método: beforeDeleteRecord.

Descrição: Elimina registros relacionados na tabela CRM_CAMPANHA_ACAO e CRM_CAMPANHA_DESPES.

Requisitos: Nenhum. 

Parâmetros: Nenhum.

 

Método: verificaAfazeresAbertos

Descrição: Verifica se o campo log_finaliza do registro está sendo alterado para TRUE. Se sim, a Tarefa relacionada com a campanha tem o campo de Status alterado para Finalizado.

Quando a campanha é finalizada, se existir Tarefas abertas relacionadas a ela, é alterado o status dessas tarefas para Suspenso. 

Requisitos: Nenhum. 

Parâmetros: Nenhum.

 

Método: createRelatedTables

Descrição: Quando eu crio uma campanha a partir de um template, o método copia também os registros das tabelas relacionadas (CRM_CAMPANHA_ACAO e CRM_CAMPANHA_TAB_PRECO) do registro que gerou a nova campanha. 

Requisitos: Nenhum. 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pi-numIdTemplate

int

 

X

 

 

Código identificador seqüencial