Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	cxbo/bocx225.p

RecordSet

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

tt-ordens-embarque, RowObject, pTableOrd, pTableOrd2
Atributos	Tipo	Formato	Descrição	Obr.
Cod-estabel	Char	X(03)	Código do Estabelecimento	Sim
Nr-proc-imp	Char	X(12)	Processo de Importação	Sim
Embarque	Char	X(16)	Embarque	Sim
Numero-ordem	Inte	zzzzz9,99	Ordem de Compra	Sim
Parcela	Inte	>>>>9	Parcela de Compra	Sim
Quantidade	Deci	>>>>>,>>9.9999	Quantidade embarcada na nossa unidade de medida	Sim
Qtd-do-forn	Deci	>>>>>,>>9.9999	Quantidade embarcada na unidade do fornecedor.	Sim
Identific-container	Char	X(20)	Identificação Container	Sim
Caracter-container	Char	X(2000)	Característica do Container	Sim
Char-1	Char	X(100)		Não
Char-2	Char	X(100)		Não
Dec-1	Deci-8	->>>>>>>>>>>9.99999999		Não
Dec-2	Deci-8	->>>>>>>>>>>9.99999999		Não
Int-1	Inte	->>>>>>>>>9		Não
Int-2	Inte	->>>>>>>>>9		Não
Log-1	Logi	Sim/não		Não
Log-2	Logi	Sim/não		Não
Data-1	Date	99/99/9999		Não
Data-2	Date	99/99/9999		Não
Check-sum	Char	X(20)		Não
r-rowid	Rowid			Sim

tt-bo-erro
Atributos	Tipo	Formato	Descrição	Obr.
i-sequen	Inte		Sequência do erro	Sim
cd-erro	Inte		Código do erro	Sim
Mensagem	Char	X(255)	Mensagem	Sim
Parametros	Char	X(255)	Parametros	Sim
Errortype	Char	X(20)	Tipo do Erro	Sim
Errorhelp	Char	X(20)	Ajuda do erro	Sim
Errorsubtype	Char		Sub-tipo do erro	Sim

tt-idioma
Atributos	Tipo	Formato	Descrição	Obr.
Cod-idioma	Char	X(12)	Código Idioma	Sim

pDelOrdem
Atributos	Tipo	Formato	Descrição	Obr.
r-rowid	Rowid			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:

findCodigo

Descrição:

Posiciona o registro conforme parametros de entrada da tabela informado.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-numero-ordem	Int	zzzzz9,99	X			Número da Ordem de Compra
c-nr-proc-imp	Char	X(12)	X			Número do Processo de Importação
c-return	Char			X		Retorna o erro.

Método:

findEmbarque

Descrição:

Posiciona o registro conforme parametros de entrada da tabela informado.

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			Embarque
c-return	Char			X		Retorna o erro.

Método:

findProcesso

Descrição:

Posiciona o registro conforme parametros de entrada da tabela informado.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
C-nr-proc-imp	Char	X(12)	X			Número do processo de importação
c-return	Char			X		Retorna o erro.

Método:

GetCurrent

Descrição:

Retorna o registro posicionado.

Requisitos:

Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
tt-desp-embarque	Temp-Table			X		Temp-Table Despesa 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-desp-embarque	Temp-table		X			Temp-table desp-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-desp-embarque	Temp-table		X			Temp-table desp-embarque
r-chave	Rowid		X			Rowid do registro a ser modificado
tt-bo-erro	Temp-table			X		Temp-tabel 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:

Pi-recebe-idioma

Descrição:

Recebe idioma do usuário

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c_cod_idiom_usuar	Char	X(12)	X			Idioma do usuario

Método:

calcularTotalembarque

Descrição:

Calcula o valor total das ordens de um embarque na moeda 0

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-cod-estabel	Char	X(03)	X			Estabelecimento
p-embarque	Char	X(12)	X			Embarque
i-mo-codigo-orig	Int	>9		X		Moeda Original
de-valor-ordens	Deci	>>>>>,>>>,>>9.99999		X		Retorna valor total das ordens do embarque

Método:

AtualizaOrdEmbAtoConce

Descrição:

Atualiza ato concessorio no ordens embarque.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-num-ordem	Int	zzzzz9,99	X			Ordem de Compra
i-parcela	Int	>>>>9	X			Parcela de Compra
c-ato-concessorio	Char			X		Ato Concessório

Método:

createOrdensEmbarque

Descrição:

Criação das Ordens Embarque via Ordens de Compra.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
r-embarque	Rowid		X			Rowid do Embarque
p-numero-ordem	Int	zzzzz9,99	X			Número da Ordem
De-quant	Deci	>>>>,>>9.9999	X			Quantidade
tt-bo-erro	Temp-table					Temp-table de erro

Método:

createPedidosembarque

Descrição:

Criação das Ordens Embarque via Pedido de Compra.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
r-embarque	Rowid		X			Rowid do Embarque
p-pedido-compra	Int	>>>>>,>>9	X			Pedido de Compra
tt-bo-erro	Temp-table					Temp-table de erro

Método:

AddOrdemEmbarque

Descrição:

Procedure que atualiza o identificar container a ordem selecionada no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-identific-container	Char	X(20)	X			Indetificador do container
p-tipo-container	Char	X(20)	X			Tipo do Container
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.
pRowidOrdensEmbarque	Rowid		X			Rowid Ordens Embarque

Método:

DelOrdemEmbarque

Descrição:

Procedure que elimina o identificar container a ordem selecionada no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pRowidOrdensEmbarque	Rowid		X			Rowid Ordens Embarque
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.

Método:

AddAllOrdemEmbarque

Descrição:

Procedure que autaliza todas as ordens com o identificar container as ordens contidas no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pRowidOrdensEmbarque	Rowid		X			Rowid Ordens Embarque
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.

Método:

DelAllOrdemEmbarque

Descrição:

Procedure que autaliza todas as ordens com o identificar container as ordens contidas no browser.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pTableOrd	Temp-Table		X			Temp-table de ordens-embarque
pDelOrdem	Temp-table				X	Temp-table com os registros eliminados.

Método:

pi-createHistEmbarque

Descrição:

Criação do registro de Acompanhamento do Embarque.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(03)	X			Estabelecimento
pEmbarque	Char	X(12)	X			Embarque
pNrProcImp	Char	X(12)	X			Número do Processo Importação
pDtEmissao	Date	99/99/9999	X			Data emissão
pCodItiner	Inte	>>,>>9	X			Código do Itinerário
pCodExportador	Inte	>>>>>>>>9	X			Código do Exportador
pCodDespachante	Inte	>>>>>>>>9	X			Código do Despachante
pCodAgente	Inte	>>>>>>>>9	X			Código do Agente
pCodFabricante	Inte	>>>>>>>>9	X			Código do Fabricante
pHistProcesso	Logical	Sim/Não	X			Informe se deve ser gerado histórico de processo.
pPtoChegada	Inte	>>,>>9	X			Ponto de Controle
c-cod-idiom-usuar	Char		X			Código do idioma do usuario
tt-bo-erro	Temp-table			X		Temp-Table com erros gerados.

Método:

pi-atualizaSitProc

Descrição:

Atualização da Situação do Processo

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pNumPedido	Inte	>>>>>,>>9	X			Pedido de Compra

Método:

createOrdensEmbarquebyparcela

Descrição:

Criação das Ordens Embarque via Ordens de Compra.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
rEmbarque	Rowid		X			Rowid do Embarque
pNumeroOrdem	Inte	zzzzz9,99	X			Ordem de compra
pParcela	Inte	>>>>9	X			Parcela de Compra
de-quant	Deci	>>>>,>>9.9999	X			Quantidade
tt-bo-erro	Temp-table			X		Temp-Table com erros gerados.

Método:

createOrdensEmbarqueNovaParcela

Descrição:

Criação das Ordens Embarque via Ordens de Compra.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
rEmbarque	Rowid		X			Rowid do Embarque
pNumeroOrdem	Inte	zzzzz9,99	X			Ordem de compra
de-quant	Deci	>>>>,>>9.9999	X			Quantidade
p-nova-qtde	Deci	>>>>,>>9,9999	X			Nova quantidade
p-data-entrega	Date	99/99/9999	X			Data entrega
tt-bo-erro	Temp-table			X		Temp-Table com erros gerados.

Método:

RetornaDataParcelaNaoEmbarcada

Descrição:

Retorna data da parcela de compra não embarcada

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(03)	X			Código do Estabelecimento
pEmbarque	Char	X(12)	X			Embarque
pNumeroOrdem	Inte	Zzzzz9,99	X			Numero Odem compra
p-data-entrega	Date	99/99/9999		X		Data entrega

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-numero-ordem	Inte	Zzzzz9,99	X			Numero Ordem Compra

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
r-rowid	Rowid		X			Rowid do Embarque

Método:

SetConstraint4

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
pCodEstabel	Char	X(03)	X			Estabelecimento
pEmbarque	Char	X(12)	X			Embarque

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
pCodEstabel	Char	X(03)	X			Estabelecimento
pEmbarque	Char	X(12)	X			Embarque
pIdentificContainer	Char	X(20)	X			Identificador do Container

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