Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

Documento de BO 

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicocxbo/bocx230a.p

 

RecordSet

 

Temp-Tables principais utilizadas para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.

tt-historico-embarque e RowObject e RowObjectAux.

OBS: Definição like à tabela historico-embarque mais os campos definidos abaixo.

Atributos

Tipo

Formato

Descrição

Obr.

r-rowid

rowid

 

Rowid do registro

Não

tt-bo-erro

Atributos

Tipo

Formato

Descrição

Obr.

i-sequen

Int

 

Seqüência do erro

Sim

cd-erro

Int

 

Código do erro

Sim

Mensagem

Char

X(255)

Mensagem

Sim

Parametros

Char

X(255)

Parâmetros

Sim

Errortype

Char

X(20)

Tipo do Erro

Sim

Errorhelp

Char

X(20)

Ajuda do erro

Sim

Errorsubtype

Char

 

Sub-tipo do erro

Sim

 

Métodos  Negócio


Métodos de acesso e leitura a base de dados.

 

 

Método:

findRowid

 

Descrição: 

Posiciona o registro conforme rowid da tabela informado.


Requisitos:

Nenhum


Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

r-chave

Rowid

 

X

 

 

Rowid do novo registro.

 

 

Método:

findChEmbarque

 

Descrição:

Posiciona o registro conforme informações fornecidas. Retorna mensagem de erro se não achou o registro.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-cod-estabel

Char

X(03)

X

 

 

Estabelecimento

c-embarque

Char

X(12)

X

 

 

Embarque

i-cod-itiner

Inte

>>,>>9

X

 

 

Código do Itinerário

c-return

Char

 

 

X

 

Retorno.

 

 

Método:

findEmbarque

 

Descrição: 

Posiciona o registro conforme informações fornecidas. Retorna mensagem de erro se não achou o registro.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-cod-estabel

Char

X(03)

X

 

 

Estabelecimento

c-embarque

Char

X(12)

X

 

 

Embarque

c-return

Char

 

 

X

 

Retorno.

       

 

Método:

findPto-Controle

 

Descrição: 

Posiciona o registro conforme informações fornecidas. Retorna mensagem de erro se não achou o registro.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

c-cod-estabel

Char

X(03)

X

 

 

Estabelecimento

i-cod-itiner

Inte

>>,>>9

X

 

 

Código do Itinerário

c-embarque

Char

X(12)

X

 

 

Embarque

i-cod-pto-contr

Inte

>>,>>9

X

 

 

Código do Ponto de Controle

c-return

Char

 

 

X

 

Retorno.

 


Método:

findPrev2

 

Descrição:

Localiza bloco de registro anterior na tabela.                         

O bloco Ú formado pelos registros com mesmo embarque e mesmo cod-itiner.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

RowObject

Temp-Table

 

 

X

 

Temp Table da tabela Histórico Embarque

 


Método:

findNext2

 

Descrição: 

Localiza próximo bloco de registro na tabela.                           

O bloco Ú formado pelos registros com mesmo embarque e mesmo cod-itiner.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

RowObject

Temp-Table

 

 

X

 

Temp Table da tabela Histórico Embarque

 

 

Método:

GetCurrent      

 

Descrição: 

Retorna o registro posicionado.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tt-historico-embarque

Temp-Table

 

 

X

 

Temp-Table histórico do embarque

 

 

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

Char

 

 

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

Char

 

 

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

Char

 

 

X

 

Campo solicitado

 

Métodos  Negócio

 

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

 

 

Método:

validateCreate

 

Descrição: 

Valida/Cria novas Cotação Despesas Adicionais do Item.

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tt-historico-embarque

Temp-table

 

X

 

 

Temp-table historico-embarque

tt-bo-erro

Temp-table

 

 

X

 

Temp-table com erros

r-chave

Rowid

 

 

X

 

Rowid do novo registro criado

 

 

Método:

validateUpdate

 

Descrição: 

Valida/Modifica as Cotação Despesas Adicionais do Item

 

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tt-historico-embarque

Temp-table

 

X

 

 

Temp-table historico-embarque

r-chave

Rowid

 

X

 

 

Rowid do registro a ser modificado

tt-bo-erro

Temp-table

 

 

X

 

Temp-tabel com erros

 

 

Método:

validateUpdateAcomp

 

Descrição: 

Valida/Modifica as sequências do histórico do embarque.

Essa procedure deve ser utilizada somente para alterar o sequenciamento dos pontos de controle de um embarque.

Requisitos:

Nenhum

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

tt-historico-embarque

Temp-table

 

X

 

 

Temp-table historico-embarque

r-chave

Rowid

 

X

 

 

Rowid do registro a ser modificado

tt-bo-erro

Temp-table

 

 

X

 

Temp-table com erros

 

 

Método:

validateDelete 

 

Descrição:

Valida/Elimina Cotação Despesas Adicionais do Item  

 

Requisitos:

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

r-chave

Rowid

 

 

 

X

Rowid do registro a ser eliminado. Retorna o próximo registro posicionado.

tt-bo-erro

Temp-table

 

 

X

 

Temp-table com erros

 

 

Método:

ValidaDespEmbarque

 

Descrição: 

Valida despesas do Embarque.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

r-emb

Rowid

 

X

 

 

Rowid da tabela historico-embarque

l-desab

Logi

Yes/no

 

X

 

Retorna se habilita ou desabilita o botão de despesa

 

Método:

setRecalcula

 

Descrição: 

Identifica se a procedure deve ou não recalcular as datas de previsão e ultima previsão durante alteração/inserção de registros.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pl-recalcula

Logi

Yes/no

 X

 

 

Define se deve ou não recalcular as datas

 

Método:

setRecord

 

Descrição: 

Seta a temp-table RowObject.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

RowObjectAux

Temp-table

 

X

 

 

Temp-table a ser setada

 

Método:

pi-verifica-decl-emitida

 

Descrição: 

Verifica se o ponto de controle possui declaração emitida.

Requisitos: 

Nenhum.

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pc-cod-estabel

char

x(5)

X

 

 

Estabelecimento

pc-embarquecharx(16)X  Embarque
pi-cod-itinerinte>>,>>9X  Código do itinerário
pi-sequenciainte>>9X  Sequência do ponto de controle
l-existe-decllogiYes/No X Se existe ou não declaração emitida

 

Método:

retornaTransportePontoAnterior

 

Descrição: 

busca o meio de transporte anterior à aquele que está sendo alterado no programa  acompanhamento do embarque de importação(im0055).

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

X(03)

X

 

 

Código do Estabelecimento

p-embarque

Char

X(12)

X

 

 

Embarque

p-cod-itiner

Inte

>>,>>9

X

 

 

Código do Itinerário

p-sequencia

Inte

>>9

X

 

 

Seqüência

p-meio-transp

Char

X(20)

 

X

 

Veiculo de Transporte

 

 

Método:

calcularDiasAcompanhamento

 

Descrição: 

Calcula o número de dias e distância total do acompanhamento do embarque

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel

Char

X(03)

X

 

 

Código do Estabelecimento

p-embarque

Char

X(12)

X

 

 

Embarque

p-dias-total

Inte

>,>>9.99

 

X

 

Número de dias que serão gastos no itinerário.

tt-bo-erro

Temp-table

 

 

X

 

Temp-table com erros

 

 

Método:

setConstraint2

 

Descrição: 

Recebe parâmetros do programa, para ser utilizados no openquery.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-opcao

Inte

>>9

X

 

 

Opção 1 ou 2.

p-r-chave

Rowid

 

X

 

 

Rowid da tabela Historico-Embaque

p-cod-estabel

Char

X(03)

X

 

 

Código do Estabelecimento

p-cod-itiner

Inte

>>,>>9

X

 

 

Código do Itinerário

p-embarque

Char

X(12)

X

 

 

Embarque

 

Método:

SetConstraint3

 

Descrição: 

Recebe parâmetros do programa, para ser utilizados no openquery.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cod-estabel-inin

Char

X(03)

X

 

 

Estabelecimento Inicial

p-cod-estabel-fim

Char

X(03)

X

 

 

Estabelecimento Final

p-embarque-ini

Char

X(12)

X

 

 

Embarque Inicial

p-embarque-fim

Char

X(12)

X

 

 

Embarque Final

p-cod-itiner-ini

Inte

>>,>>9

X

 

 

Itinerário Inicial

p-cod-itiner-fim

Inte

>>,>>9

X

 

 

Itinerário Final

 

Método:

SetConstraint5

 

Descrição: 

Recebe parâmetros do programa, para ser utilizados no openquery.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-r-chave

rowid

 

X

 

 

Rowid do registro a ser posicionado para coletar as informações de "código estabelecimento", "código do itinerário" e "código do embarque".

p-nr-sequencia-ini

Inte

>>9

X

 

 

Sequência inicial

p-nr-sequencia-fim

Inte

>>9

X

 

 

Sequência final

p-cod-pto-contr-ini

Inte

>>,>>9

X

 

 

Código do ponto de controle inicial

p-cod-pto-contr-fim

Inte

>>,>>9

X

 

 

Código do ponto de controle final

 

 

Método:

OpenQuery     

 

Descrição: 

Abre a temp-table para ser utilizada no programa.

 

Requisitos: 

Nenhum.

 

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

i-abertura

Inte

>>9

X

 

 

Número do OpenQuery a ser utilizado pelo programa