Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr010

 

Objetivo

Validação, Manutenção e acesso rápido a tabela “mab-event”.

 

Funcionamento

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

...

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:

...

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-evento

char

x(08)

Código do Evento

Sim \ Key

001

desc-evento

char

x(30)

Descrição do Evento

Sim

001

des-abrev

char

x(10)

Descrição Abreviada

Não

001

Idi-valor

Int

9

Indicador – Valor

Sim

001

cod-grp-event

char

x(8)

Código do Grupo de Eventos

Sim

001

Idi-comp-event

Int

9

Indicador - Componente Evento

Sim

001

Idi-fix-var

Int

9

Indica se custo é fixo ou variável

Sim

001

log-cust-km

logical

Sim/Não

Indica se evento entra em custo/percurso equipamento

Sim

001

log-integr-ap

logical

Sim/Não

Integração Contas Pagar

Não

001

log-infracao

logical

Sim/Não

Infração

Não

001

ct-despesa

char

X(8)

Conta para lançamentos de despesas dos eventos dos equipamentos

Não

001

cod-espec-tit

Char

!!

Espécie do Título do Contas a Pagar

Não

001

log-integr-cust

logical

Sim/Não

Integra Custos Frotas

Não

001

tp-codigo

int

>>9

Tipo de Despesa do Evento

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

log-envia-ccusto

Logical

Sim/Não

Envia Centro Custo

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

Descrição

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

 

Parâmetros

Descrição

 

pcod-evento

Código 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.

 

  

 

getKey

 

Requisito

Nenhum

 

Sintaxe

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

 

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

pcod-evento

Código 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.

 

    

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

getDecField

  

RequisitoRequisito

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

   

getRecidField

 

Nenhum

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.

 

   

gotoEvento

 

Requisito

Nenhum

Sintaxe

run gotoEvento in h-handle (input <character>).

 

Descrição

Faz uma busca na bfmab-event, verifica se registro foi encontrado, em caso de erro será retornada flag "NOK":U. Reposiciona query através de rowid e verifica a ocorrência de erros, caso existam erros será retornada flag "NOK":U

 

 

Parâmetros

Descrição

 

pcod-evento

Código 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.

 

...

 

OpenQuery / SetConstraint / LinkTo

setConstraintCodEvento

  

Requisito

Nenhum

Sintaxe

run setConstraintCodEvento in h-handle (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 de Código do Envento.

 

 

Parâmetros

Descrição

 

pCdEventIni

Código Evento Inicial

 

pCdEventFim

Código Evento Final

 

pOleo

Log do Oleo

 

pFiltro

Log do Fltro

 

pMecanica

Log da Mecanica

 

pParada

Log de Parada

 

pCustos

Log de Custos

 

pOutros

Log de Outros

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.

 

 

    

SetConstraintCodEvento-2

 

Requisito

Nenhum

 

Sintaxe

run setConstraintCodEvento-2 in h-handle (input <character>,

                                          input <character>,

                                          input <logical>,

                                          input <logical>,

                                          input <logical>,

                                          input <logical>,

                                          input <logical>,

                                          input <logical>,

                                          input <logical>).

Descrição

Seta as restrições para abrir a query utilizando Código do Evento.

 

 

Parâmetros

Descrição

 

pCdEventIni

Código Evento Inicial

 

pCdEventFim

Código Evento Final

 

pOleo

Log do Oleo

 

pFiltro

Log do Fltro

 

pMecanica

Log da Mecanica

 

pParada

Log de Parada

 

pInfracao

Log de Infração

 

pCustos

Log de Custos

 

pOutros

Log de Outros

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.

 

...

setConstraintCodGrpEvento

 

Requisito

  

 

setConstraintCodGrpEvento

  

Nenhum

Sintaxe

Requisito

Nenhum

 

Sintaxe

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

                                          input <character>,

                                          input <logical>,

                                          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 de Grupo de Eventos.

 

Parâmetros

Descrição

 

pCdGrpEventIni

Código do Grupo de Envento Inicial

 

pCdGrpEventFim

Código do Grupo de Envento Final

 

pOleo

Log do Oleo

 

pFiltro

Log do Fltro

 

pMecanica

Log da Mecanica

 

pParada

Log de Parada

 

pCustos

Log de Custos

 

pOutros

Log de Outros

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.

 

   

SetConstraintCodGrpEvento-2

  

Requisito

Nenhum

Sintaxe

run setConstraintCodGrpEvent-2 in h-handle (input <character>,

                                            input <character>,

                                            input <logical>,

                                            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 de Grupo de Eventos.

 

 

Parâmetros

Descrição

 

pCdGrpEventIni

Código do Grupo de Envento Inicial

 

pCdGrpEventFim

Código do Grupo de Envento Final

 

pOleo

Log do Oleo

 

pFiltro

Log do Fltro

 

pMecanica

Log da Mecanica

 

pParada

Log de Parada

 

pInfracao

Log de Infração

 

pCustos

Log de Custos

 

pOutros

Log de Outros

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.

    

 SetConstraintDescricao

  

Requisito

Nenhum

Sintaxe

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

                                        input <character>,

                                        input <logical>,

                                        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 Descrição de Eventos.

 

Parâmetros

pDescEventIni

Descrição

Descrição do Evento Inicial

pDescEventFim

Descrição do Eventos Final

pOleo

Log do Oleo

pFiltro

Log do Fltro

pMecanica

Log da Mecanica

pParada

Log de Parada

pCustos

Log de Custos

pOutros

Log de Outros

    

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.

 

SetConstraintDescricao-2

  

Requisito

Nenhum.

 

Sintaxe

run setConstraintDescricao-2 in h-handle (input <character>,

                                          input <character>,

                                          input <logical>,

                                          input <logical>,

                                          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 Descrição de Eventos.

 

Parâmetros

Descrição

 

pDescEventIni

Descrição do Evento Inicial

 

pDescEventFim

Descrição do Evento Final

 

pOleo

Log do Oleo

 

pFiltro

Log do Fltro

 

pMecanica

Log da Mecanica

 

pParada

Log de Parada

 

pInfracao

Log de Infração

 

pCustos

Log de Custos

 

pOutros

Log de Outros

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

  

openQueryMain    

 

Sintaxe

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.

    

openQueryCodEvento

  

Requisito

A setConstraintCodEvento ter sido executada anteriormente.

 

Sintaxe

run openQueryCodEvento in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código do Evento utilizando os filtros da setConstraintcodEvento.

 

 

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.

 

   

OpenQueryCodEvento-2

  

Requisito

A setConstraintCodEvento-2 ter sido executada anteriormente.

Sintaxe

run openQueryCodEvento-2 in h-handle.

 

Descrição

Abre a query da BO conforme a faixa de Código do Evento utilizando os filtros da setConstraintcodEvento-2.

 

 

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.

 

 

...

 

openQueryCodGrpEvent

  

Requisito

A setConstraintCodGrpEvent ter sido executada anteriormente.

 

Sintaxe

run openQueryCodGrpEvent in h-handle.

 

Descrição

Abre a query da BO conforme a faixa de Código do grupo Evento utilizando os filtros da setConstraintcodGrpEvent.

 

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.

 

 

 

...

 

OpenQueryCodGrpEvent-2

    

Requisito

A setConstraintCodGrpEvent-2 ter sido executada anteriormente.

Sintaxe

run openQueryCodGrpEvent-2 in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código do grupo Evento utilizando os filtros da setConstraintCodGrpEvent-2.

 

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.

    

openQueryDescricao

   

Requisito

A setConstraintDescricao ter sido executada anteriormente.

Sintaxe

run openQueryDescricao in h-handle.

Descrição

Abre a query da BO conforme a Descrição utilizando os filtros da setConstraintDescricao.

 

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.

 

    

table RowErrors.

OpenQueryDescricao-2

   

Requisito

A setConstraintDescricao-2 ter sido executada anteriormente.

Sintaxe

run openQueryDescricao-2 in h-handle.

Descrição

Abre a query da BO conforme a Descrição utilizando os filtros da setConstraintDescricao-2.

 

 

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.

 

...

 

verificaFlag

  

Requisito

Nenhum

 

Sintaxe

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

                              output <integer>).

 

Descrição

Valida algumas opções que podem ser executadas em cima do registro da tabela corrente da BO.

 

Parâmetros

Descrição

 

pCodEvento

Código do Evento

 

pFlag

Flag

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

    

 

validaGrupoEvento

  

Requisito

Nenhum

 

Sintaxe

run validaGrupoEvento in h-handle (input  <character>).

 

Descrição

Valida se o evento é do tipo Custo, ou seja, igual a “5“.

 

Parâmetros

Descrição

 

pCodEvento

Código 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 tt-erro....