Documento de BO

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

RecordSet

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

tt-desp-embarque e RowObject

OBS: A definição da Temp-table deve ser like à tabela desp-embarque mais os campos 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	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-campo-erro
Atributos	Tipo	Formato	Descrição	Obr.
campo	char		Nome do campo com 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:

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:

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-cod-estabel	Char	X(12)	X			Código do Estabelecimento
p-embarque	Char	X(03)	X			Embarque
p-cod-itiner	Inte	>>,>>9	X			Código do Itinerário
p-cod-pto-contr	Inte	>>,>>9	X			Código do Pontro de Controle

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	Char	X(12)	X			Código do Estabelecimento
p-embarque	Char	X(03)	X			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
p-rowid	Rowid		X			Rowid da tabela Historico-Embarque

Método:

SetConstraint6

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-rowid	Rowid		X			Rowid da tabela Historico-Embarque
p-pto-ini	inte	>>,>>9	X			Ponto de controle inicial
p-pto-fim	inte	>>,>>9	X			Ponto de controle final

Método:

SetConstraint7

Descrição:

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

Requisitos:

Nenhum.

def input parameter p-estabel like desp-embarque.cod-estabel no-undo.
def input parameter p-embarque like desp-embarque.embarque no-undo.
def input parameter p-pto-ini like desp-embarque.cod-pto-contr no-undo.
def input parameter p-pto-fim like desp-embarque.cod-pto-contr no-undo.
def input parameter p-desp-ini like desp-embarque.cod-desp no-undo.
def input parameter p-desp-fim like desp-embarque.cod-desp no-undo.
def input parameter p-moeda like desp-embarque.mo-codigo no-undo.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-estabel	Char	X(5)	X			Código do Estabelecimento
p-embarque	Char	X(16)	X			Embarque
p-pto-ini	Int	>>,>>9	X			Ponto de controle inicial
p-pto-fim	Int	>>,>>9	X			Ponto de controle final
p-desp-ini	Int	>>,>>9	X			Despesa inicial
p-desp-fim	Int	>>,>>9	X			Despesa final
p-moeda	Int	>9	X			Moeda

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

Método:

findCodigo

Descrição:

Posiciona em um registro de acordo com os parâmetros recebidos.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcod-estabel	Char	x(5)	X			Número do OpenQuery a ser utilizado pelo programa
pembarque	Char	X(16)	X			Número do embarque
pcod-itiner	Int	>>,>>9	X			Código do itinerário
pcod-pto-contr	Int	>>,>>9	X			Código do ponto de controle
pcod-desp	Int	>>,>>9	X			Código da despesa
c-return	Char			X		Retorno

Método:

findDespesa

Descrição:

Posiciona em um registro de acordo com os parâmetros recebidos.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcod-estabel	Char	x(5)	X			Número do OpenQuery a ser utilizado pelo programa
pembarque	Char	X(16)	X			Número do embarque
pcod-desp	Int	>>,>>9	X			Código da despesa
c-return	Char			X		Retorno

Método:

pi-valida-despesa-acomp

Descrição:

Validação da despesa do ponto do itinerário. Verifica duplicatas e se o ponto de controle está faturado.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
RowObject	Temp-table		X			Despesa a ser validada
tt-bo-erro	Temp-table			X		Erros encontrados na validação

Método:

getFieldErrors

Descrição:

Retorna os campos em que ocorreram erros durante os processos de alteração/criação de um registro.

Requisitos:

Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
tt-campo-erro	Temp-table			X		Campos em que ocorreram erro

Árvore de páginas

BOCX310 - Despesas do Embarque

Documento de BO

RecordSet

Métodos Negócio

Métodos Negócio

Métodos Negócio