Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

Tabela Temporária

Descrição

Entrada/Saída

RowObject

Tabela de comunicação entre Interface e banco de dados da tabela “mnd-solicit-pagto”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Num-doc

Int

>>>,>>>,>>9

Solicitação de Pagamento

Sim\Key

001

Cod-emitente

Int

>>>>>>>>9

Código do emitente do documento

Sim\Key

001

Cod-estado

Char

X(4)

Unidade da federação

Sim

001

Cod-pais

Char

X(20)

Código País

Sim

001

Dat-incial

Date

99/99/9999

Data da inclusão da Solicitação

Sim

001

Hra-inicial

Char

99:99:99

Hora Inclusão da Solicitação

Sim

001

Dat-final

Date

99/99/9999

Data Encerramento da Solicitação

Não

001

Hra-final

Char

99:99:99

Hora Encerramento da Solicitação

Não

001

Idi-estado-solicit

Int

9

Estado Solicitação

Não

001

Val-data-hora-invertda

Dec

999999999999

Data Hora Invertida

Não

001

Cod-usuar

Char

X(12)

Código Usuário

Não

001

Dsl-obs

Char

X(2000)

Informações adicionais

Não

001

Cod-estabel

Char

X(3)

Código do Estabelecimento

Sim

001

Idi-integr-pagar

Int

9

Indica se solicitação implanta título ou baixa antecipação

Não

001

cod-livre-1

char

x(1000)

Character Livre

Não

001

cod-livre-2

char

x(1000)

Character Livre

Não

001

log-livre-1

log

Sim/Não

Logical Livre

Não

001

log-livre-2

log

Sim/Não

Logical Livre

Não

001

num-livre-1

int

->>>>>>>>>9

Inteiro Livre

Não

001

num-livre-2

int

->>>>>>>>>9

Inteiro Livre

Não

001

val-livre-1

dec

->>>>>>>>>>>9.9

Decimal Livre

Não

001

val-livre-2

dec

->>>>>>>>>>>9.9

Decimal Livre

Não

001

dat-livre-1

date

99/99/9999

Data livre

Não

001

dat-livre-2

date

99/99/9999

Data livre

Não

001

Tabela Temporária

Descrição

Entrada/Saída

RowErrors e

RowErrorsAux

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

001

ErrorNumber

integer

padrão

Número do erro

Sim

001

ErrorDescription

char

padrão

Descrição do erro

Sim

001

ErrorParameters

char

padrão

Parâmetros passados para criar mensagem

Não

001

ErrorType

char

padrão

Tipo do erro:

WARNING: Aviso

ERROR: Erro

Sim

001

ErrorHelp

char

padrão

Texto de ajuda do erro

Sim

001

ErrorSubType

char

padrão

Sub Tipo da mensagem de erro

Não

001

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

Número 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.

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

Número  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.

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.

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.

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.

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.

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.

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.

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.

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.

Requisito

Nenhum

Sintaxe

run setConstraintData in h-handle (input <date>,

                                   input <date>

                                   input <date>

                                   input <date>

                                   input <logical>,

                                   input <logical>

                                   input <logical>

                                   input <logical>

                                   input <logical>

                                   input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de datas.

Parâmetros

Descrição

pDtIncialIni

Data Inicial

pDtIncialFim

Data Inicial Final

pDtFinalIni

Data Final Inicial

pDtFinalFim

Data Final

pPendente

Pendente (Sim\Não)

pEmOrfamento

Em orçamento (Sim\Não)

pOrcado

Orçado (Sim\Não)

pTitulo

Titulo (Sim\Não)

pEncerrado

Encerrado (Sim\Não)

pCancelado

Cancelado (Sim\Não)

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.

Requisito

Nenhum

Sintaxe

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

                                     input <integer>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de Código do documento.

Parâmetros

Descrição

pDoctoIni

Código do documento Inicial

pDoctoFim

Código do documento Final

pPendente

Pendente (Sim\Não)

pEmOrfamento

Em orçamento (Sim\Não)

pOrcado

Orçado (Sim\Não)

pTitulo

Titulo (Sim\Não)

pEncerrado

Encerrado (Sim\Não)

pCancelado

Cancelado (Sim\Não)

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.

Requisito

Nenhum

Sintaxe

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

                                       input <integer>,

                                       input <character>,

                                       input <character>,

                                       input <logical>,

                                       input <logical>,

                                       input <logical>,

                                       input <logical>,

                                       input <logical>,

                                       input <logical>).

Descrição

Seta as restrições para abrir a query por faixa Código do emitente e Código do estabelecimento.

Parâmetros

Descrição

pEmitenteIni

Código Emitente Inicial

pEmitenteFim

Código Emitente Final

pEstabelIni

Código Estabelecimento Inicial

pEstabelFim

Código Estabelecimento final

pPendente

Pendente (Sim\Não)

pEmOrfamento

Em orçamento (Sim\Não)

pOrcado

Orçado (Sim\Não)

pTitulo

Titulo (Sim\Não)

pEncerrado

Encerrado (Sim\Não)

pCancelado

Cancelado (Sim\Não)

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.

Requisito

A setConstraintData  ter sido executada anteriormente.

Sintaxe

run openQueryData in h-handle.

Descrição

Abre a query da BO conforme a faixa de Datas.

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.

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.

Requisito

A setConstraintDocumento ter sido executada anteriormente.

Sintaxe

run openQueryDocumento in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código do Documento.

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.

Requisito

A setConstraintEmitente  ter sido executada anteriormente.

Sintaxe

run openQueryEmitente in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código do Emitente e Código do Estabelecimento.

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.

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.

Requisito

Nenhum

Sintaxe

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

Descrição

Busca a próxima numeração do documento.

Parâmetros

Descrição

pDoc

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 tt-erro....

Requisito

Nenhum

Sintaxe

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

                             output <decimal>).

Descrição

Calcula os  Valores dos Eventos.

Os valores não podem ser menor que 1900.

Parâmetros

Descrição

pDocto

Código do Documento

pValor

Valor

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 tt-erro....

Requisito

Nenhum

Sintaxe

run eliminaFilhos in h-handle (input <rowid>).

Descrição

Elimina os registros das tabelas filhas da tabela “mnd-solicit-pagto.

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 tt-erro....

Requisito

Nenhum.

Sintaxe

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

                                 input <date>,

                                 input <character>).

Descrição

Finaliza Eventos solicitados .

Parâmetros

Descrição

pNumDocto

Código do Documento

pDataFim

Data de finalização

pHoraFim

Hora de finalização

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 tt-erro....

Requisito

Nenhum.

Sintaxe

RUN validaTela IN h-handle (input <character>,

                            input <integer>,

                            input <decimal>,

                            input <integer>) .

Descrição

Valida os campos obrigatórios da tela corrente.

Parâmetros

Descrição

pEstabel

Código do Estabelecimento

pRefer

Código da Referencia

pMoeda

Moeda

pSerie

Série

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).

Requisito

Nenhum.

Sintaxe

RUN verificaEventos IN <handle> (input <integer>,

                                  output <logical>,).

Descrição

Verifica se um Evento existe e verifica as movimentações do mesmo.

Parâmetros

Descrição

pNumDocto

Código do Documento

pOK

OK (Sim\Não)

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).

Requisito

Procedure chamada pelo método interno deleteRecord. Não deve ser chamada externamente.

Sintaxe

run beforeDeleteRecord in h-handle.

Descrição

Realiza override antes de eleminar algum registro.

Parâmetros

Descrição

Nenhum

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 tt-erro....

Requisito

Procedure executa a partir da procedure “finalizaEventos”.

Sintaxe

RUN criaHistEvento IN h-handle (input <integer>).

Descrição

Através dos Parâmetros recebidos é executado a procedure “criaHist” na bofr118, onde literalmente é criado os devidos históricos

Parâmetros

Descrição

pNrDocto

Número do Documento do Processo

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).