Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	inbo/boin01030.p
Include com Parâmetros	inbo/boin01030.i
Banco:	movind
Tabela:	fornec-solicit-cotac

Considerações Gerais

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela fornec-solicit-cotac (Fornecedor da Solicitação de Cotação).

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.

A sintaxe para executar a BO em modo persistente é:

run inbo/boin01030.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

RowObject					Entrada/Saída
Fornecedor da Solicitação de Cotação					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn-fornec	INTEGER	>>>>>>>>9	Código do Fornecedor	Sim
des-e-mail	CHARACTER	x(2000)	E-Mails para envio	Não
assunto-email	CHARACTER	x(100)	Assunto do e-mail	Não
dsl-texto	CHARACTER	x(2000)	Texto Mensagem	Não
log-responde-via-web	LOGICAL	Sim/Não	Responde Via Web	Não
cod-livre-1	CHARACTER	x(500)	Livre 1	Não
cod-livre-2	CHARACTER	x(500)	Livre 2	Não
cod-livre-3	CHARACTER	x(500)	Livre 3	Não
cod-livre-4	CHARACTER	x(500)	Livre 4	Não
dat-livre-1	DATE	99/99/9999	Livre 1	Não
dat-livre-2	DATE	99/99/9999	Livre 2	Não
dat-livre-3	DATE	99/99/9999	Livre 3	Não
dat-livre-4	DATE	99/99/9999	Livre 4	Não
log-livre-1	LOGICAL	Sim/Não	Livre 1	Não
log-livre-2	LOGICAL	Sim/Não	Livre 2	Não
log-livre-3	LOGICAL	Sim/Não	Livre 3	Não
log-livre-4	LOGICAL	Sim/Não	Livre 4	Não
num-livre-1	INTEGER	>>>>>>>>9	Livre 1	Não
num-livre-2	INTEGER	>>>>>>>>9	Livre 2	Não
num-livre-3	INTEGER	>>>>>>>>9	Livre 3	Não
num-livre-4	INTEGER	>>>>>>>>9	Livre 3	Não
val-livre-1	DECIMAL	->>>>>>>>>>>9.99999999	Livre 1	Não
val-livre-2	DECIMAL	->>>>>>>>>>>9.99999999	Livre 2	Não
val-livre-3	DECIMAL	->>>>>>>>>>>9.99999999	Livre 3	Não
val-livre-4	DECIMAL	->>>>>>>>>>>9.99999999	Livre 4	Não
cdd-solicit	DECIMAL	>>>,>>>,>>>,>>>,>>9	Código da solicitação de Cotação	Sim
log-planilha-envda	LOGICAL	Sim/Não	Planilha enviada	Não
log-confir-entreg	LOGICAL	Sim/Não	Confirmação de Entrega	Não
log-confir-recebto	LOGICAL	Sim/Não	Confirmação de Recebimento	Não

ttPurchaseOrderlinesList					Entrada/Saída
Ordens a serem vinculadas/processadas					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
numero-ordem	INTEGER	zzzzz9,99	Ordem de compra	Sim

ttVendorList / ttVendorListAux					Entrada/Saída
Fornecedores a serem vinculados no processo de cotação					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-emitente	INTEGER	>>>>>>>>9	Código do Fornecedor	Sim
nome-abrev	CHARACTER	X(12)	Nome Abreviado Fornecedor	Não
e-mail	CHARACTER	x(170)	E-Mail fornecedor	Não
it-codigo	CHARACTER	X(16)	Código do item	Não
attach	LOGICAL	yes/no	Envia anexo	Não
attachFile	CHARACTER	x(8)	Arquivo de anexo	Não
numero-ordem	INTEGER	zzzzz9,99	Ordem de compra	Não
mailText	CHARACTER	x(8)	Texto do e-mail	Não
newVendor	LOGICAL	yes/no	Novo fornecedor	Não
sendCopyTo	CHARACTER	x(8)	Envia cópia	Não
cgc	CHARACTER	x(19)	CGC/CPF	Não
sendEmail	LOGICAL	yes/no	Envia e-mail	Não
subject	CHARACTER	x(8)	Assunto e-mail	Não
sequencia	INTEGER	>>9	Sequência	Não
ordens	CHARACTER	x(8)	Ordens de compra	Não
l-fornec-clic	LOGICAL	yes/no	Fornecedor do Clicbusiness	Não
reputacao	DECIMAL	->>,>>9.99	Reputação do fornecedor	Não
razao-social	CHARACTER	x(60)	Razão Social	Não
fm-codigo	CHARACTER	x(8)	Família	Não
desc-familia	CHARACTER	x(30)	Descrição da família	Não
nome-emit	CHARACTER	x(80)	Nome fornecedor	Não

ttContact / ttContactAux					Entrada/Saída
Contatos dos fornecedores					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-emitente	INTEGER	>>>>>>>>9	Código do fornecedor	Sim
sequencia	INTEGER	>>9	Sequência de contato	Sim
nome	CHARACTER	x(40)	Nome do contato	Não
e-mail	CHARACTER	x(170)	E-Mail do contato	Não

RowErrors					Entrada/Saída
Erros ocorridos durante a execução do programa.					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ErrorSequence	INTEGER		Sequência	Sim
ErrorNumber	INTEGER		Número	Sim
ErrorDescription	CHARACTER		Descrição	Não
ErrorParameters	CHARACTER		Parâmetros	Não
ErrorType	CHARACTER		Tipo de erro	Não
ErrorHelp	CHARACTER		Texto de ajuda	Não
ErrorSubType	CHARACTER		Sub-tipo do erro	Não

Método Básico

Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

getCharField
Requisito	Query posicionada no registro.
Sintaxe	RUN getCharField IN handle (INPUT <character>, OUTPUT <character>).
Descrição	Retorna valor dos campos do tipo caracter
	Parâmetros	Descrição
	pFieldName	Nome do campo caracter que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo caracter que foi solicitado.

getDateField
Requisito	Query posicionada no registro.
Sintaxe	RUN getDateField IN handle (INPUT <character>, OUTPUT <date>).
Descrição	Retorna valor dos campos do tipo data
	Parâmetros	Descrição
	pFieldName	Nome do campo data que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo data que foi solicitado.

getDecField
Requisito	Query posicionada no registro.
Sintaxe	RUN getDecField IN handle (INPUT <character>, OUTPUT <decimal>).
Descrição	Retorna valor dos campos do tipo decimal
	Parâmetros	Descrição
	pFieldName	Nome do campo decimal que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo decimal que foi solicitado.

getIntField
Requisito	Query posicionada no registro.
Sintaxe	RUN getIntField IN handle (INPUT <character>, OUTPUT <integer>).
Descrição	Retorna valor dos campos do tipo inteiro
	Parâmetros	Descrição
	pFieldName	Nome do campo inteiro que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo inteiro que foi solicitado.

getLogField
Requisito	Query posicionada no registro.
Sintaxe	RUN getLogField IN handle (INPUT <character>, OUTPUT <logical>).
Descrição	Retorna valor dos campos do tipo logico
	Parâmetros	Descrição
	pFieldName	Nome do campo logico que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo logico que foi solicitado.

getRawField
Requisito	Query posicionada no registro.
Sintaxe	RUN getRawField IN handle (INPUT <character>, OUTPUT <raw>).
Descrição	Retorna valor dos campos do tipo raw
	Parâmetros	Descrição
	pFieldName	Nome do campo raw que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo raw que foi solicitado.

getRecidField
Requisito	Query posicionada no registro.
Sintaxe	RUN getRecidField IN handle (INPUT <character>, OUTPUT <recid>).
Descrição	Retorna valor dos campos do tipo recid
	Parâmetros	Descrição
	pFieldName	Nome do campo recid que será retornado o valor
	pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo recid que foi solicitado.

getKey
Requisito	Query posicionada no registro.
Sintaxe	RUN getKey IN handle (OUTPUT <pcdd-solicit>, OUTPUT <pcdn-fornec>).
Descrição	Retorna chave primária e única da tabela.
	Parâmetros	Descrição
	pcdd-solicit (decimal)	Código da Solicitação de Cotação
	pcdn-fornec (integer)	Código do fornecedor
Retorno	A BO irá retornar o valor contido na chave primária e única do registro que foi solicitado.

goToKey
Requisito	Query estar aberta.
Sintaxe	RUN goToKey IN h-handle (INPUT <pcdd-solicit>, INPUT <pcdn-fornec>).
Descrição	Reposiciona registro com base no índice primário e único da tabela.
	Parâmetros	Descrição
	pcdd-solicit (decimal)	Código da Solicitação de Cotação
	pcdn-fornec (integer)	Código do fornecedor
Retorno	A BO irá reposicionar no registro que foi solicitado.

ValidateRecord
Requisito	Query posicionada no registro.
Sintaxe	Run validateRecord in handle (input <character>).
Descrição	Validações pertinentes ao DBO.
	Parâmetros	Descrição
	pType	Recebe o tipo de validação (Create, Delete, Update) create: Indica a criação de um registro update: Indica a atualização de um registro delete: Indica a eliminação de um registro
Retorno

findByKey
Requisito	Query estar aberta.
Sintaxe	RUN findByKey IN h-handle (INPUT <pcdd-solicit>, INPUT <pcdn-fornec>).
Descrição	Reposiciona registro com base no índice primário e único da tabela.
	Parâmetros	Descrição
	pcdd-solicit (decimal)	Código da Solicitação de Cotação
	pcdn-fornec (integer)	Código do fornecedor
Retorno	A BO irá reposicionar no registro que foi solicitado. Caso o registro não seja localizado, insere um registro na RowErrors e retorna NOK

getSuggestedVendors
Requisito	Ordens de compra cadastradas.
Sintaxe	RUN getSuggestedVendors IN h-handle (INPUT TABLE <ttPurchaseOrderlinesList>, OUTPUT TABLE <ttVendorList>, OUTPUT TABLE <ttContact>, OUTPUT TABLE <RowErrors>).
Descrição	Retorna os fornecedores sugeridos com base em uma lista de ordens de compra.
	Parâmetros	Descrição
	ttPurchaseOrderlinesList (temp-table)	Lista de ordens de compra
	ttVendorList (temp-table)	Lista com os fornecedores sugeridos
	ttContact (temp-table)	Lista com os contatos dos fornecedores
	RowErrors(temp-table)	Erros ocorridos no processo.
Retorno	Lista de fornecedores com contatos e temp-table com erros ocorridos no processo.

getQuotationProcessVendors
Requisito	Fornecedores vinculados ao processo de cotação.
Sintaxe	RUN getQuotationProcessVendors IN h-handle (INPUT <pCddSolicit>, OUTPUT TABLE <ttVendorList>, OUTPUT TABLE <ttContact>, OUTPUT TABLE <RowErrors>).
Descrição	Retorna informações de fornecedores vinculados ao processo de cotação.
	Parâmetros	Descrição
	pCddSolicit (decimal)	Número do processo de cotação.
	ttVendorList (temp-table)	Informações dos fornecedores
	ttContact (temp-table)	Contatos dos fornecedores
	RowErrors(temp-table)	Erros ocorridos no processo.
Retorno	Dados dos fornecedores e temp-table com erros ocorridos no processo.

getVendorByRequisition
Requisito	Ordem de compra cadastrada.
Sintaxe	RUN getVendorByRequisition IN h-handle (INPUT <piPurchaseRequisitionNumber>, INPUT-OUTPUT TABLE <ttVendorListAux>).
Descrição	Retorna informações de fornecedores do item da ordem de compra
	Parâmetros	Descrição
	piPurchaseRequisitionNumber (integer)	Número da ordem de compra
	ttVendorListAux (temp-table)	Informações dos fornecedores
Retorno	Dados dos fornecedores.

pi-valida-email
Requisito	nenhum
Sintaxe	RUN pi-valida-email IN h-handle (INPUT <pc-email>, OUTPUT <pl-valido>).
Descrição	Retorna se o e-mail é válido ou não.
	Parâmetros	Descrição
	pc-email (character)	E-mail a ser validado
	pl-valido (logical)	Indica se o e-mail é válido
Retorno	Variável lógica indicando se o e-mail é válido.

getVendorContact
Requisito	Fornecedor cadastrado.
Sintaxe	RUN getVendorContact IN h-handle (INPUT <piCodEmitente>, INPUT-OUTPUT TABLE <ttContactAux>).
Descrição	Retorna informações de contatos dos fornecedores
	Parâmetros	Descrição
	piCodEmitente(integer)	Código do fornecedor
	ttContactAux (temp-table)	Contatos do fornecedor
Retorno	Contatos do fornecedor.

OpenQuery / SetConstraint / LinkTo

openQueryMain
Requisito	Nenhum
Sintaxe	run openQueryStatic in h-handle (input "Main":U).
Descrição	Faz a abertura da query principal.
	Parâmetros	Descrição

Retorno