Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

boCrmCampanhaDespes.p

 

RecordSet

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

RowObject

Atributo

Tipo

Formato

        Descrição

Obr.

num_id

int

99999999

Código identificador seqüencial

Sim 

Num_id_campanha

Int

>>>>,>>9

Campanha

Sim

Num_id_tip_deseds

Int

999999999

Tipo de Despesa

Sim

Num_id_umd

Int

>>>>,>>9

Unidade de Medida

Sim

Qtd_itens_despes

Dec

999999999

Quantidade

Sim

Val_despes_previs

Dec

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

Valor de Despesa Previsto

Sim

Dsl_tip_despes

Char

X(2000)

Observação

Não

Dat_timestamp

Date

99/99/9999

Data de Alteração do Registro

Sim

Cdd_version

Dec

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

Versão

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:

  • Não permite criar dois registros que contenham tipo de despesa e campanha iguais.
  • Não permite que a quantidade de itens seja menor ou igual a 0.
  • Não permite que o valor da despesa seja menor ou igual a 0.

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: totalizaDespesCampanha.

Descrição: Soma todas as despesas da campanha, para que o valor total das despesas esteja sempre atualizado.

Requisitos: Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-NUM_ID_CAMPANHA

Int

 

X

 

 

Código Identificador Seqüencial