Árvore de páginas

Documento de BO 

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicocxbo/bocx295.p

 

RecordSet

 

Tabela principal utilizada para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.

SCP-Status

Atributo

Tipo

Formato

Descrição

Obr.

Cod-estabel

Char

X(3)

Código do Estabelecimento

Sim

Embarque

Char

X(12)

Número do Embarque

Sim

Nr-invoice

Char

X(12)

Fatura Comercial

Sim

Parcela

Char

X(2)

Parcela

Sim

Dt-vencim

Date

99/99/9999

Data Vencimento

Sim

Vl-invoice

Deci-2

>>>>>,>>>,>>9.9

Valor Invoice

Sim

Mo-codigo

Inte

>9

Moeda

Sim

Char-1

Char

x(100)

Campo Vazio

Não

Char-2

Char

x(100)

Campo Vazio

Não

Dec-1

Deci-8

->>>>>>>>>>>9.9

Campo Vazio

Não

Dec-2

Deci-8

->>>>>>>>>>>9.9

Campo Vazio

Não

Int-1

Inte

->>>>>>>>>9

Campo Vazio

Não

Int-2

Inte

->>>>>>>>>9

Campo Vazio

Não

Log-1

Logi

Sim/Não

Campo Vazio

Não

Log-2

Logi

Sim/Não

Campo Vazio

Não

Data-1

Date

99/99/9999

Campo Vazio

Não

Data-2

Date

99/99/9999

Campo Vazio

Não

Check-sum

Char

X(20)

Check-sum

Não

 

Métodos Básicos

 

Métodos básicos de acesso ao banco de dados, que serão utilizados na base EMS 2.02.

 


Método:

ExecuteUpdate

 

Descrição:

Grava os valores da Tabela Temporária na tabela invoice-emb-imp.

 

Requisitos:

Nenhum

 

Parâmetros:

Nenhum

 


Método:

ValidateFields

 

Descrição:

Faz a validação dos campos, antes da gravação na tabela invoice-emb-imp. A Data de vencimento precisa ser válida, e caso não seja, será mostrada uma mensagem de erro. A moeda da fatura precisa ser válida, sendo comparada contra a tabela “moeda”. Se não for localizada, ocorrerá uma mensagem de erro de “Registro não Localizado”. E ainda, o valor da fatura deverá ser maior que 0 (vl-invoice), caso contrário, uma mensagem de erro será exibida.

 

Requisitos:

Nenhum

 

Parâmetros:

Nenhum

 


Método:

ValidateCreate

 

Descrição: 

Valida a criação do registro, para que não haja duplicidade no mesmo. No caso do Código do Estabelecimento estiver em branco, exibe uma mensagem de erro, se não estiver em branco, e ao buscar o código do estabelecimento na tabela “estabelec”, não encontrar nenhum registro, exibe uma mensagem de erro de “Estabelecimento não Encontrado”. Essa mesma validação ocorre para o Número do Embarque, que não pode estar em branco, e precisa ser válido para a criação da Fatura. Já o número da fatura (nr-invoice) e da parcela, basta que estejam preenchidos. Se não forem encontrados erros, esse método irá verificar se essa chave de Fatura já existe na tabela “invoice-emb-imp”. Caso ela já exista, será mostrada uma mensagem de erro, para evitar a duplicação na Fatura.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

Table for RowObject

Table

 

X

 

 

Tabela RowObject

Table for tt-bo-erro

Table

 

 

X

 

Tabela de Erros

r-chave

Rowid

 

 

X

 

Rowid do registro criado

 

 

Método:

getCharfield

 

Descrição: 

Retorna o campo solicitado do registro que estiver posicionado. Só para campos caracteres.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-nome-campo

Char

 

X

 

 

Nome do campo.

c-retorno

Char

 

 

X

 

Campo solicitado

 

 

Método:

getIntfield

 

Descrição: 

Retorna o campo solicitado do registro que estiver posicionado. Só para campos inteiros.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-nome-campo

Char

 

X

 

 

Nome do campo.

i-retorno

Inte

 

 

X

 

Campo solicitado

 

Método:

getDecfield

 

Descrição: Retorna o campo solicitado do registro que estiver posicionado. Só para campos decimais.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-nome-campo

Char

 

X

 

 

Nome do campo.

De-retorno

Decimal

 

 

X

 

Campo solicitado

 

 

Método:

getLogfield

 

Descrição:

Retorna o campo solicitado do registro que estiver posicionado. Só para campos lógicos.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-nome-campo

Char

 

X

 

 

Nome do campo.

l-retorno

Logical

 

 

X

 

Campo solicitado

 

 

Método:

getDatefield

 

Descrição: 

Retorna o campo solicitado do registro que estiver posicionado. Só para campos do tipo data.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-nome-campo

Char

 

X

 

 

Nome do campo.

da-retorno

Date

 

 

X

 

Campo solicitado

  

Métodos de Negócio

 

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

 

 

Método:

InicializarFaturaOrdem

 

Descrição: 

Sugere o valor para a criação das Faturas. Executa o método {cxbo/bocx225.i1}

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

x(3)

X

 

 

Código do Estabelecimento

p-embarque

Char

X(12)

X

 

 

Código do Embarque

p-vl-invoice

Deci-2

>>>>>,>>>,>>9.9

 

X

 

Valor da Fatura

p-dt-vencim

Date

99/99/9999

 

X

 

Data de vencimento

p-mo-codigo

Inte

>9

 

X

 

Moeda

 

 

Método:

Pi-Busca-Documentos

 

Descrição:

Busca os documentos de uma Fatura, preenchendo uma Temp-Table (tt-documentos) com o número, o tipo e a data de cada documento encontrado na Fatura.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

x(3)

X

 

 

Código do Estabelecimento

p-nr-embarque

Char

X(12)

X

 

 

Código do Embarque

p-dt-trans

Date

99/99/9999

X

 

 

Data de Emissão

tt-documentos

Table

 

 

X

 

Tabela TT-Documentos

 

 

Método:

FindInvoice

 

Descrição: 

Procura uma Fatura pelo índice, se encontrar, posiciona a Query no registro encontrado, senão, retorna uma mensagem de “Registro não encontrado”.

 

Requisitos: 

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-cod-estabel

Char

x(3)

X

 

 

Código do Estabelecimento

c-embarque

Char

X(12)

X

 

 

Código do Embarque

c-nr-invoice

Char

X(12)

X

 

 

Número da Fatura

c-parcela

Char

x(2)

X

 

 

Parcela

c-return

Char

X(20)

 

X

 

Mensagem de Erro padrão EMS

 


Método:

CalculaValorInvoice

 

Descrição: 

Calcula o valor total da Fatura, do Material e das Despesas pagas ao Fornecedor do Material.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

x(3)

X

 

 

Código do Estabelecimento

p-embarque

Char

X(12)

X

 

 

Código do Embarque

p-total-ordens

Decimal

>>>>>,>>>,>>9.99999

 

X

 

Total da Ordem

p-mo-codigo

Inte

>9

 

X

 

Moeda

tt-bo-erro

Temp-table

 

 

X

 

Tabela de Erros

 

 

Método:

ValidarTotalInvoice

 

Descrição: 

Valida o valor da fatura e consiste com o valor total do embarque. O valor total das faturas tem que ser menor ou igual ao valor total do embarque.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

x(3)

X

 

 

Código do Estabelecimento

p-embarque

Char

X(12)

X

 

 

Código do Embarque

tt-bo-erro

Temp-table

 

 

X

 

Tabela de Erros

 

 

Método:

GeraFaturaEmbarque

 

Descrição: 

Gera Faturas automaticamente para o Embarque.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

x(3)

X

 

 

Código do Estabelecimento

p-embarque

Char

X(12)

X

 

 

Código do Embarque

p-nr-invoice

Char

X(12)

X

 

 

Número da Fatura

tt-bo-erro

Temp-table

 

 

X

 

Tabela de Erros

 

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:

SetConstraint2

 

Descrição: 

Recebe os parâmetros do programa, para serem usados no OpenQuery.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-invoice

Char

x(12)

X

 

 

Número da Fatura

 


Método:

SetConstraint3

 

Descrição: 

Recebe os parâmetros do programa, para serem usados no OpenQuery.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-est

Char

x(3)

X

 

 

Código do Estabelecimento

c-emb

Char

X(12)

X

 

 

Código do embarque

 


Método:

SetConstraint4

 

Descrição: 

Recebe os parâmetros do programa, para serem usados no OpenQuery.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

r-estab

Rowid

 

X

 

 

Rowid da Tabela Estabelecimento

 


Método:

OpenQueryMain

 

Descrição:

Busca todos os registros da tabela.

 

Constraints Associados:

Nenhum.