Linha Datasul

Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr135

 

Objetivo

Validação, Manutenção e acesso rápido a tabela “mab-relac-eqpto-sub-sist”.

 

Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “Mpn-transf”.

Na forma padrão, realiza-se a chamada através de um comando RUN.

A sintaxe para a chamada BO é:

run frbo\bofr135.p.

 

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr135.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 BO.

 

Tabelas Temporárias

Nos atributos das tabelas temporárias:

Tabela Temporária

Descrição

Entrada/Saída

RowObject

Tabela de comunicação entre Interface e banco de dados da tabela “mab-relac-eqpto-sub-sist”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

num-docto 

Int

 >>>,>>>,>>9

Numero do documento

Sim

 

cod-estab-orig 

Char

 x(5)

Código Estabelecimento Origem do Documento

Sim

 

cod-estab-dest

Char

 x(5)

Código Estabelecimento Destino do Documento

Sim

 

cod-usuario

Char

 x(15)

Usuário

Não

 

dat-transf 

Date

 99/99/9999

Data de Transferência

Sim

 

hra-transf 

Char

 99:99

Hora Transferência

Não

 

idi-tip-transf

Int

 9

Tipo Transferência

Não

 

cdn-emitente  

Int

 >>>>>>>>9

Código do Emitente

Não

 

cod-nota-fisc

Char

 x(16)

Nota Fiscal

Não

 

cod-serie

Char

 x(5)

Série

Não

 

val-dat-hora-invrtda

Dec

 999999999999

Data e Hora invertida

Não

 

cod-livre-1 

Char

 x(100)

Character Livre

Não

 

cod-livre-2

Char

 x(500)

Character Livre

Não

 

log-livre-1

Log

Sim/Não

Logical Livre

Não

 

log-livre-2

Log

Sim/Não

Logical Livre

Não

 

num-livre-1  

Int

 >>>>>>>>9

Inteiro Livre

Não

 

num-livre-2

Int

>>>>>>>>9

Inteiro Livre

Não

 

val-livre-1  

Dec

>>>>>>>>>>>9.9

Decimal Livre

Não

 

val-livre-2

De

>>>>>>>>>>>9.9

Decimal Livre

Não

 

dat-livre-1

Date

99/99/9999

Data Livre

Não

 

dat-livre-2

Date

99/99/9999

Data Livre

Não

 

Tabela Temporária

Descrição

Entrada/Saída

RowErrors

Contém os erros ocorridos na BO.

Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ErrorSequence

integer

padrão

Seqüência dos erros

Sim

 

ErrorNumber

integer

padrão

Número do erro

Sim

 

ErrorDescription

char

padrão

Descrição do erro

Sim

 

ErrorParameters

char

padrão

Parâmetros passados para criar mensagem

Não

 

ErrorType

char

padrão

Tipo do erro:

WARNING: Aviso

ERROR: Erro

Sim

 

ErrorHelp

char

padrão

Texto de ajuda do erro

Sim

 

ErrorSubType

char

padrão

Sub Tipo da mensagem de erro

Não

 

 

Métodos

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

 

Método Básico

goToKey

Requisito

Nenhum

Sintaxe

run goToKey in h-handle (input <integer>).

Descrição

Reposiciona a query com base na chave primária da tabela.

 

Parâmetros

Descrição

 

pnum-docto

recebe valor do campo num-docto

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getKey

Requisito

Nenhum

Sintaxe

run getKey in h-handle (output <integer>).

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

pnum-docto

recebe valor do campo num-docto

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getCharField

Requisito

Nenhum

Sintaxe

run getCharField in h-handle (input  <character>,

                              output <character>).

Descrição

Retorna os valores dos campos da tabela que são caracteres.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getDateField

Requisito

Nenhum

Sintaxe

run getDateField in h-handle (input  <character>,

                              output <date>).

Descrição

Retorna os valores dos campos da tabela que são data.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getDecField

Requisito

Nenhum

Sintaxe

run getDecField in h-handle (input  <character>,

                             output <decimal>).

Descrição

Retorna os valores dos campos da tabela que são decimais.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getIntField

Requisito

Nenhum

Sintaxe

run getIntField in h-handle (input  <character>,

                             output <integer>).

Descrição

Retorna os valores dos campos da tabela que são inteiros.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getLogField

Requisito

Nenhum

Sintaxe

run getLogField in h-handle (input  <character>,

                             output <logical>).

Descrição

Retorna os valores dos campos da tabela que são Lógicos.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getRawField

Requisito

Nenhum

Sintaxe

run getRawField in h-handle (input  <character>,

                             output <raw>).

Descrição

Retorna os valores dos campos da tabela que são caracteres longos.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getRecidField

Requisito

Nenhum

Sintaxe

run getRecidField in h-handle (input  <character>,

                               output <recid>).

Descrição

Retorna os valores dos campos da tabela que são numéricos e definem uma seqüência única para a tabela dentro do database.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado

 

pFieldValue

Valor do campo.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

getRowid

Requisito

Nenhum

Sintaxe

run getRowid in h-handle (output <rowid>).

Descrição

Retorna o ROWID do registro corrente da Query que está aberta na BO. Este método não aparece para ser manutenido.

 

Parâmetros

Descrição

 

pRowid

Rowid da tabela.

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintDocumento

Requisito

Nenhum.

Sintaxe

run setConstraintDocumento in h-handle (input <integer>).

Descrição

Seta as restrições para abrir a query por Documento.

Abre a query para uma faixa de modelo e plano.

 

Parâmetros

Descrição

 

pNumDocto

Código do Documento

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryDocumento

Requisito

A setConstraintEquipamento ter sido executada anteriormente.

Sintaxe

run openQueryDocumentoin h-handle.

Descrição

Abre a query da BO conforme as restrições passadas na procedure setConstraintEquipamento.

Abre a query da BO conforme as restrições passadas na procedure setConstraintEquipamento.

Abre a query para uma faixa de modelo e plano.

 

Parâmetros

Descrição

 

Não Contém

 

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryDocumentoZ

Requisito

A setConstraintDocumentoZ ter sido executada anteriormente.

Sintaxe

run openQueryDocumentoZ h-handle.

Descrição

Abre a query da BO conforme as restrições passadas na procedure setConstraintDocumentoZ.

Abre a query da BO conforme as restrições passadas na procedure setConstraintEquipamento.

Abre a query para uma faixa de modelo e plano.

 

Parâmetros

Descrição

 

Não Contém

 

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintDocumentoZ       

 

Requisito

Nenhum.

Sintaxe

run setConstraintDocumentoZ in h-handle (input <integer>,

                                         input <integer>,

                                         input <character>,

                                         input <character>,

                                         input <character>,

                                         input <character>).

Descrição

Seta as restrições para abrir a query por Documento.

Abre a query para uma faixa de modelo e plano.

 

Parâmetros

Descrição

 

pNumDoctoIni

Código do Documento Inicial

 

pNumDoctoFim

Código do Documento Final

 

pCodEstabOrigIni

Estabelecimento Origem Inicial

 

pCodEstabOrigFim

Estabelecimento Origem Final

 

pCodEstabDestIni

Estabelecimento Destino Inicial

 

pCodEstabDestFim

Estabelecimento Destino Final

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryNotaFiscal     

Requisito

A setConstraintNotaFiscal ter sido executada anteriormente.

Sintaxe

run openQueryNotaFiscal h-handle.

Descrição

Abre a query da BO conforme as restrições passadas na procedure setConstraintNotaFiscal.

Abre a query da BO conforme as restrições passadas na procedure setConstraintEquipamento.

Abre a query para uma faixa de modelo e plano.

 

Parâmetros

Descrição

 

Não Contém

 

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintNotaFiscal

 

Requisito

Nenhum.

Sintaxe

run setConstraintNotaFiscal in h-handle (input <character>,

                                         input <character>,

                                         input <character>,

                                         input <character>,

                                         input <character>,

                                         input <character>,

                                         input <character>,

                                         input <character>).

Descrição

Seta as restrições para abrir a query por Nota Fiscal.

Abre a query para uma faixa de modelo e plano.

 

Parâmetros

Descrição

 

pNotaFisIni

Numero Nota Fiscal Inicial

 

pNotaFisFim

Numero Nota Fiscal Final

 

pSerieIni

Numero Série Inicial

 

pSerieFim

Numero Série Final

 

pCodEstabOrigIni

Estabelecimento Origem Inicial

 

pCodEstabOrigFim

Estabelecimento Origem Final

 

pCodEstabDestIni

Estabelecimento Destino Inicial

 

pCodEstabDestFim

Estabelecimento Destino Final

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

openQueryMain    

 

Requisito

Nenhum

Sintaxe

run openQueryMain in h-handle.

Descrição

Abre a query da BO com todos os registros.

 

Parâmetros

Descrição

 

Não Contém

 

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.


Método Negócio

validateRecord

Requisito

Ter sido executada alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.

Sintaxe

run validate in this-procedure (input <character>).

Descrição

Valida as ações feitas em cima do registro da tabela corrente da BO. Estas ações podem ser: “CREATE”, “UPDATE” e “DELETE”.

 

Parâmetros

Descrição

 

pType

 

 

Tipo de ação:

“CREATE”

“UPDATE”

“DELETE”

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.