Linha Datasul

Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr035


Objetivo

Validação, Manutenção e acesso rápido a tabela “mmv-plano-prevent”.


Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr035.p.


A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr035.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 “mmv-plano-prevent”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-model

Char

X(8)

Código do Modelo

Sim


cod-plano

Char

X(8)

Plano Manutenção

Sim


des-plano-manut

Char

X(30)

Descrição do Plano de Manutenção

Sim


vli-dia

Int

>,>>>,>>9

Frequência em Dias



vli-dia-aviso

Int

>>>,>>9

Antecipação em dias



val-km-padr

Dec

>>,>>>,>>9.9

Padrão para manutenção, de acordo com a unidade



val-km-aviso

Dec

>>,>>>,>>9

Aviso para chamada do evento

Sim


cod-evento

Char

X(8)

Código do Evento

Sim


cod-sub-sist

Char

X(8)

Código Sub-Sistema

Sim


cd-tipo

Int

>>,>>9

Tipo de Manutenção



val-tempo-padr

Dec

>>9.99

Tempo Padrão Execução Serviços



cod-calend-padr

Char

X(10)

Calendário Padrão



log-gera-tar-om

Log

Sim/Não

Gera Tarefa para Ordem de Manutenção

Sim


log-gera-manut

Log

Sim/Não

Gera Ordem de Manutenção



cod-livre-1

char

X(100)

Livre 1



cod-livre-2

char

X(100)

Livre 2



log-livre-1

Log

Sim/Não

Livre 1



log-livre-2

Log

Sim/Não

Livre 2



num-livre-1

Int

->>>>>>>>>9

Livre 1



num-livre-2

Int

->>>>>>>>>9

Livre 2



val-livre-1

Dec

->>>>>>>>>>>9.9999

Livre 1



val-livre-2

Dec

->>>>>>>>>>>9.9999

Livre 2



dat-livre-1

date

99/99/9999

Livre 1



dat-livre-2

date

99/99/9999

Livre 2



cod-setor-ofici

Char

x(8)

Código do Setor da Oficina



idi-tip-model

Int

9

Indicador - Tipo Modelo

Sim


log-cont-sec

Log

Sim/Não

Contador Secundário



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 <character>,

                         input <character>).

Descrição

Reposiciona o registro do tabela mmv-plano-prevent através dos campos código do modelo e código do plano.

 

Parâmetros

Descrição

 

pcod-model

Código do modelo

 

pcod-plano

Código do plano

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

                        output <character>).

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

pcod-model

Código do modelo

 

pcod-plano

Código do plano

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.

 

OpenQuery / SetConstraint

setConstraintCodModEqpto

Requisito

Nenhum

Sintaxe

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

                                          input <character>).

Descrição

Carrega as variável com o código do modelo  para  openQueryCodModEqpto.

 

Parâmetros

Descrição

 

pCodModEqptoIni

Código do modelo inicial

 

pCodModEqptoFim

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

setConstraintCodPlManut

Requisito

Nenhum

Sintaxe

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

                                         input <character>).

Descrição

Carrega as variável com o código do plano para openQueryCodPlManut.

 

Parâmetros

Descrição

 

pCodPlManutIni

Código do plano inicial

 

pCodPlManutFim

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

openQueryCodModEqpto

Requisito

Executar o método setConstraintCodModEqpto.

Sintaxe

run openQueryCodModEqpto in h-handle.

Descrição

Busca conjunto de registros da tabela mmv-plano-prevent com base código do modelo. Os registros são ordenados pelo código do modelo.

 

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.

openQueryCodPlManut

Requisito

Executar o método setConstraintCodPlManut.

Sintaxe

run openQueryCodPlManut in h-handle.

Descrição

Busca conjunto de registros da tabela mmv-plano-prevent com base código do plano. Os registros são ordenados pelo código do 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.

openQueryModeloPlano

Requisito

A setConstraintCodModEqpto e setConstraintCodPlManut ter sido executada anteriormente.

Sintaxe

run openQueryModeloPlano in h-handle.

Descrição

Abre a query com os registros de Planos de Prevenção.

 

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

Busca conjunto de registros da tabela mmv-plano-prevent. Os registros são ordenados pelo código do modelo e código do 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.


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.

copiaFilhos

Requisito

Nenhum

Sintaxe

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

                             input <character>,

                             input <character>,

                             input-output <character>,).

Descrição

Copia registros das tabelas filhas de um Plano para outro.

 

Parâmetros

Descrição

 

pModeloOrig

Código do modelo de origem

pPlanoOrig

Código do plano de origem

pModeloDest

Código do modelo de destino

pPlanoDest

Código do plano de destino

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

geraPlanos

Requisito

Nenhum

Sintaxe

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

                            input <character>).

Descrição

Gera os planos de manutenção para os equipamentos relacionados ao modelo informado. Verifica se modelo é do tipo componente se modelo não  é do tipo componente, Se não for verifica se já existe plano para o equipamento, se existe pergunta se quer sobrepor os planos. Se não existem um plano cria um novo.

 

Parâmetros

Descrição

 

pCodModel

Código do modelo

pCodPlano

Código do plano

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

afterCreateRecord

Requisito

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

Sintaxe

run afterCreateRecord in this-procedure.

Descrição

Override após a criação do registro.

 

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

criaRelacionamentoGrupo

Requisito

Nenhum.

Sintaxe

run criaRelacionamentoGrupo in this-procedure.

Descrição

Criação do relacionamento entre grupo de equipamento e sub-sistema.

 

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