Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr119

 

Objetivo

Validação, Manutenção e acesso rápido a tabela “mnd-movto-infracao”.

 

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr007.p.

 

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr007.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 “mnd-movto-infracao”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Num-doto

Int

>>>,>>>,>>9

Número Interno da Infração

Sim\Key

 

ep-codigo

Int

>>9

Código da Empresa do Equipamento

Sim\Key

 

Cod-eqpto

Char

X(16)

Código do Equipamento

Sim\Key

 

Cod-ait

Char

X(25)

Código Auto Infração Trânsito

Sim

 

Cod-enquand

Char

X(12)

Código Enquadramento

Sim\Key

 

Dta-infracao

date

99/99/9999

Data Infração

Sim

 

Hra-infracao

Char

99:99:99

Hora Infração

Sim

 

Val-dat-hora-infracao

dec

999999999999

Valor da Data Hora Invertida da Infração

Key

 

Cod-cidade

Char

X(25)

Código da Cidade

Sim

 

Cod-estado

Char

X(4)

Unidade da federação

Sim

 

Cod-pais

Char

X(20)

Código do País

Sim

 

Dsl-obds

Char

X(2000)

Informações adicionais

Não

 

Cod-num-notif

Char

X(25)

Código do Número Notificação

Não

 

Dat-emis-notif

date

99/99/9999

Data Emissão Notificação

Não

 

Dat-indic-defesa

date

99/99/9999

Data Limite de Indicação do Motorista e Defesa

Key

 

Cod-matr

Char

X(10)

Matrícula do Motorista

Key

 

Cod-habilit

Char

X(20)

Código Habilitação

Não

 

Cod-estado-habilit

Char

X(4)

Código da Unidade Federação da Habilitação

Não

 

Cod-pais-habilit

Char

X(20)

Código do País da Habilitação

Não

 

Cod-descta-infracao

Log

Sim\Não

Desconta Infração

Key

 

Cod-num-penalid

Char

X(25)

Código Número Penalidade

Não

 

Dat-emis-penalid

Date

99/99/9999

Data de Emissão da Penalidade

Não

 

Val-infracao

dec

>>,>>>,>>>,>>9.99

Valor da Infração

Não

 

Val-desconto

dec

>>,>>>,>>>,>>9.99

Valor do desconto da infração

Não

 

Dat-vencto

date

99/99/9999

Data de vencimento da Infração

Key

 

Num-docto-orig

Int

>>>,>>>,>>9

Número da Infração de origem

Não

 

Cod-usuar

Char

X(12)

Código do Usuário de Implantação da Infração

Não

 

cod-usuar-aprvdor

Char

X(12)

Código do Usuário Aprovador Nível 1

Não

 

idi-estado-infracao

Int

9

Status da Infração

Sim\Key

 

dat-pagto

date

99/99/9999

Data de Pagamento da Infração

Key

 

val-pago

dec

>>,>>>,>>>,>>9.99

Valor Pago da Infração

Não

 

idi-estado-aprov

Int

9

Estado Aprovação

Não

 

cod-usuar-aprvdor-2

Char

X(12)

Código Usuário Aprovador Nível 2

Não

 

dat-aprov-desc

date

99/99/9999

Data Aprovação Desconto

Não

 

dsl-obs-aprov

Char

X(2000)

Observação da Aprovação da Infração

Não

 

cc-codigo

Char

X(20)

Centro Custo do Equipamento no momento da infração

Não

 

cod-estabel

Char

X(3)

Código do Estabelecimento do Equipamento no momento da infração

Não

 

cod-categ

Char

X(4)

Indicar a categoria da habilitação

Não

 

des-ender

Char

X(100)

Endereço da Infração

Não

 

cod-emitente

Int

>>>>>>>>9

Código do emitente da infração

Não

 

ep-codigo-matr

Int

>>9

Empresa do Motorista

Não

 

cod-estabel-matr

Char

X(3)

Estabelecimento do Motorista

Não

 

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

 

Métodos

Quando a 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

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.

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

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.

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.

getMovtoEvento

Requisito

Nenhum

Sintaxe

run getMovtoEvento in h-handle (output <table>).

Descrição

Retorno o movimento do evento.

 

Parâmetros

Descrição

 

ttMovtoEvento

Temp-Table do movimento do evento

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.

gotoAit

Requisito

Nenhum

Sintaxe

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

                         output <character>).

Descrição

Busca na mnd-movto-infracao pelo número interno da infração o código auto infração trânsito.                                                       

 

Parâmetros

Descrição

 

pDocto

Número Interno da Infração

 

 pAit

Código Auto Infração Trânsito

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.

 

OpenQuery / SetConstraint / LinkTo

linkToUsuarEstab

Requisito

Ser chamado somente quando há o Join entre a tabela em questão e a mnd-movto-infracao.

Sintaxe

run linkToUsuarEstab in h-handle (input <hanlde>).

Descrição

Recebe como parâmetro o handle da BO da tabela mnd-movto-infracao, para buscar a chave primária da mesma (do registro corrente na BO).

 

Parâmetros

Descrição

 

pHandle

Handle da BO.

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.

setConstraintData

Requisito

Nenhum

Sintaxe

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

                                   input <date>,

                                   input <logical>,

                                   input <logical>,

                                   input <logical>,

                                   input <logical>).

Descrição

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

 

Parâmetros

Descrição

 

pDataIni

Data Inicial

 

pDataFim

Data Final

 

pNotificacao

Notificação (Sim\Não)

 

pRecurso

Recurso (Sim\Não)

 

pLiquidada

Liquidada (Sim\Não)

 

pCancelada

Cancelada (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.

setConstraintDocto

Requisito

Nenhum

Sintaxe

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

                                     input <integer>,

                                     input <character>,

                                     input <character>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de código de documento e de infração.

 

Parâmetros

Descrição

 

pDoctoIni

Código do Documento Inicial

 

pDoctoFim

Código do Documento Final

 

pAitIni

Código Auto Infração de Trânsito Inicial

 

pAitFim

Código Auto Infração de Trânsito Final

 

pNotificacao

Notificação (Sim\Não)

 

pRecurso

Recurso (Sim\Não)

 

pLiquidada

Liquidada (Sim\Não)

 

pCancelada

Cancelada (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.

setConstraintEnquadramento

Requisito

Nenhum

Sintaxe

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

                                            input <character>,

                                            input <logical>,

                                            input <logical>,

                                            input <logical>,

                                            input <logical>).

Descrição

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

 

Parâmetros

Descrição

 

pEnquadIni

Código do enquadramento Inicial

 

pEnquadFim

Código do enquadramento Final

 

pNotificacao

Notificação (Sim\Não)

 

pRecurso

Recurso (Sim\Não)

 

pLiquidada

Liquidada (Sim\Não)

 

pCancelada

Cancelada (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.

setConstraintEquipamento

Requisito

Nenhum

Sintaxe

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

                                            input <integer>,

                                            input <character>,

                                            input <character>,

                                            input <character>,

                                            input <character>,

                                            input <logical>,

                                            input <logical>,

                                            input <logical>,

                                            input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de empresa, equipamento e estabelecimento.

 

Parâmetros

Descrição

 

pEmpIni

Código da Empresa Inicial

 

pEmpFim

Código da Empresa Final

 

pEqptoIni

Código do Equipamento Inicial

 

pEqptoFim

Código do Equipamento Final

 

pEstabIni

Código do Estabelecimento Inicial

 

pEstabFim

Código do Estabelecimento Final

 

pNotificacao

Notificação (Sim\Não)

 

pRecurso

Recurso (Sim\Não)

 

pLiquidada

Liquidada (Sim\Não)

 

pCancelada

Cancelada (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.

setConstraintFiltro

Requisito

Nenhum

Sintaxe

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

                                     input <logical>,

                                     input <logical>,

                                     input <logical>,

                                     input <logical>).

Descrição

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

 

Parâmetros

Descrição

 

pCodEstabel

Código do Estabelecimento

 

pPendAproNivel1

Pendente Nivel 1 (Sim\Não)

 

pFinalizNivel1

Finalizado Nível 1 (Sim\Não)

 

pPendAproNivel2

Pendente Nivel 2 (Sim\Não)

 

pFinalizNivel2

Finalizado Nível 2 (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.

setConstraintUsuarEstab

Requisito

Nenhum

Sintaxe

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

                                            input <character>).

Descrição

Seta as restrições para abrir a query por faixa de Código de usuário e de estabelecimento .

 

Parâmetros

Descrição

 

pCodUsuar

Código do Usuário

 

pCodEstabel

Código do Estabelecimento

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.

openQueryData

Requisito

A setConstraintData   ter sido executada anteriormente.

Sintaxe

run openQueryData in h-handle.

Descrição

Abre a query da BO conforme a faixa de data.

 

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.

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.

openQueryDocto

Requisito

A setConstraintDocto ter sido executada anteriormente.

Sintaxe

run openQueryDocto 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.

openQueryEnquadramento

Requisito

A setConstraintEnquadramento ter sido executada anteriormente.

Sintaxe

run openQueryEnquadramento in h-handle.

Descrição

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

 

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.

openQueryEquipamento

Requisito

A setConstraintSituacao ter sido executada anteriormente.

Sintaxe

run openQueryEquipamento in h-handle.

Descrição

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

 

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.

openQueryFiltro

Requisito

A setConstraintFiltro   ter sido executada anteriormente.

Sintaxe

run openQueryfiltro in h-handle.

Descrição

Abre a query da BO conforme dados passados para o filtro.

 

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.

openQueryUsurEstab

Requisito

A setConstraintFiltro   ter sido executada anteriormente.

Sintaxe

run openQueryUsurEstab in h-handle.

Descrição

Abre a query da BO conforme faixa de códigos do usário e 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.

 

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.

setaVariavel

Requisito

Nenhum

Sintaxe

run setaVariavel in this-procedure.

Descrição

Seta variável corrente para opção NO

 

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

buscaDocumento

Requisito

Nenhum

Sintaxe

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

Descrição

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

 

Parâmetros

Descrição

 

pDoc

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

buscaEstablEqpto

Requisito

Ser executado apenas quando é feita uma cópia de registro.

Sintaxe

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

                                  input <character>,

                                  input <date>,

                                  output <character>

                                  output <character>).

Descrição

Busca o estabelcimento e equipamento.

 

Parâmetros

Descrição

 

pi-ep-codigo

Código da Empresa

 

pc-cod-eqpto

Código do Equipamento

 

pdt-dat-infracao

Data da Infração

 

pc-cod-estabel

Código do Estabelecimento

 

pc-cc-codigo

Código do Centro de Custo

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

buscaMovimento

Requisito

Nenhum.

Sintaxe

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

                                output <integer>).

Descrição

Busca movimentação dos documentos.

 

Parâmetros

Descrição

 

pNumDocto

Número do Documento

 

pDoctoMovimento

Código do Movimento

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

buscaValor

Requisito

Nenhum.

Sintaxe

run buscaValor in h-handle (output <character >,

                                output <character >,

                             output<character>).

Descrição

Busca valor da infração.

 

 

Parâmetros

Descrição

 

pCidade

 Cidade

 

pEstado

Estado

 

pPais

País

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

criaMovimentoEvento

Requisito

Nenhum.

Sintaxe

RUN criaMovimentoEvento IN THIS-PROCEDURE.

Descrição

Criação do Movimento de Evento quando informada data de vencimento

 

 

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

setMovtoEvento

Requisito

Nenhum.

Sintaxe

RUN setMovtoEvento in h-handle ( INPUT <temp-table>) .

Descrição

Recebe movimento do evento.

 

Parâmetros

Descrição

 

ttMovtoEven

Código da Empresa do Equipamento de Origem.

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

validateParametros

Requisito

Nenhum.

Sintaxe

RUN validateParametros in this-procedure .

Descrição

Valida os parametros.

 

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

verificaInfracaoEqpto

Requisito

Nenhum.

Sintaxe

RUN verificaInfracaoEqpto in this-procedure .

Descrição

Verifica se determinado equipamento possui alguma infração.

 

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

validateInfracao

Requisito

Nenhum.

Sintaxe

RUN validateInfracao in this-procedure .

Descrição

Valida informações sobre a infração.

 

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

afterCreateRecord

Requisito

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

Sintaxe

run afterCreateRecord in h-handle.

Descrição

Realiza override após criação de 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....

afterUpdateRecord

Requisito

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

Sintaxe

run afterUpdateRecord in h-handle.

Descrição

Realiza override após criação de algum registro e cria relacionamento entre o Grupo do equipamento e Sub-Sistema.

 

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

beforeCreateRecord

Requisito

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

Sintaxe

run beforeCreateRecord in h-handle.

Descrição

Realiza override antes da criação de 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....

beforeUpdateRecord

Requisito

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

Sintaxe

run beforeUpdateRecord in h-handle.

Descrição

Realiza override antes de alterar 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....

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))