Linha Datasul

Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

boCrmCidade.p

 

RowObject

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

 

defaults.i                  

Include padrão para geração da sequence, método default de openQuery e busca pelo usuário logado.       

RowObject

Atributo

Tipo

Formato

        Descrição

Obr.

NUM_ID

int

99999999

Código identificador seqüencial

Sim 

nom_cidade

char

x(32)

Descrição

Sim

num_ddd

int

9999

DDD

Não

cod_cidad_erp

char

x(8)

Código no ERP

Não

num_id_uf

Int

>>>>,>>9

Código da UF (fk)

Sim

log_integrad_erp

Log

Sim/Não

Integrado do ERP

Sim

num_suframa

int

>>>>,>>9

Número Suframa

Não

LOG_SUSPENSO

Log

Sim/Não

Flag de Registro Suspenso

Sim

val_perc_icms_zfm

dec

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

Valor Percentual Icms Zona franca manaus

Não

cdn_munpio_ibge

int

>>>,>>9

Código - Município IBGE

Não

cdn_domic_fisc

int

>>>,>>9

Código - Domicilio Fiscal

Não

Dat_timestamp

Date

99/99/9999

Data de Alteração do Registro

Sim

Cdd_version

Dec

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

Versão

Sim

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 chave 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ções pertinentes ao DBO para as operações de Create, Update e Delete.

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:  ValidateChangeDescriptionCity

Descrição: Validação de duplicidade de registros com mesma descrição.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: ValidateDeleteCity

Descrição: Verifica se existem registros relacionados a Cidade.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: validateUFSuspended

Descrição: Verifica se a Cidade esta suspensa.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: setConver

Descrição: seta variável lógica que determina que o registro veio da conversão.

Requisitos: Nenhum

Parâmetros: Nenhum