Linha Datasul

Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 mnbo/bomn014.p

 

Objetivo

Validação, Manutenção e acesso rápido a tabela “mi-eq-tar”.

 

Funcionamento

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

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

A sintaxe para a chamada BO é:

run mnbo\bomn014.p.

 

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run mnbo\bomn014.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 “mi-eq-tar”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cd-equipto

Char

X(16)

Equipamento

Sim

 

cd-manut

Char

X(8)

Manutenção

Sim

 

cd-tarefa

int

>>>>9

Tarefa Manutenção

Sim

 

descricao

Char

X(45)

descrição

Sim

 

fi-codigo

int

>>>>9

Ficha Método

 

 

narrativa

char

x(2000)

Narrativa

 

 

var-afer

char

X(30)

Variável Aferida

 

 

inf-padrao

Log

Sim/Não

Informa Padrao

 

 

vl-padrao

dec

->>>,>>>,>>9.9999

Valor Padrão

 

 

tp-variavel

Int

>9

Tipo da Variável de Aferição

 

 

var-menor

dec

->>>,>>>,>>9.9999

Variação a Menor

 

 

var-maior

dec

->>>,>>>,>>9.9999

Variação a Maior

 

 

un-medida

char

x(12)

Unidade de Medida

 

 

aceite

log

Sim/Não

Aceite

 

 

local-taref

Int

>9

Localização

 

 

dias-antec

Int

->>>9

Defasagem

 

 

est-liber

int

9

Estado Liberação

 

 

cd-taref-padr

int

>>>>9

Tarefa Padrão

 

 

nr-pontos

int

>>>,>>9

Pontos Lubrificação

 

 

usuario-aceite

char

x(12)

Usuário Aceite

 

 

nome-abrev

char

x(12)

Nome Abreviado

 

 

cod-video

char

x(30)

Vídeo

 

 

cod-imagem

char

x(30)

Imagem

 

 

tar-obrigatoria

log

Sim/Não

Tarefa Obrigatória

 

 

char-1

char

X(100)

Livre 1

 

 

char-2

char

X(100)

Livre 2

 

 

log -1

Log

Sim/Não

Livre 1

 

 

log- 2

Log

Sim/Não

Livre 2

 

 

int-1

Int

->>>>>>>>>9

Livre 1

 

 

int-2

Int

->>>>>>>>>9

Livre 2

 

 

dec-1

Dec

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

Livre 1

 

 

dec-2

Dec

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

Livre 2

 

 

data-1

date

99/99/9999

Livre 1

 

 

data-2

date

99/99/9999

Livre 2

 

 

cd-turno

Integer

>>9

Turno

 

 

tempo

dec

->>>>>,>>9.9999

Tempo

Sim

 

exec-simul

Log

Sim/Não

Execução Simultânea

 

 

sequencia

Integer

>>>>9

Sequência

Sim

 

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

                         input <integer>).

Descrição

Reposiciona o registro da Tarefa Manutenção\Equipamento através do código do equipamento, da manutenção e do código da tarefa da manutenção.

 

Parâmetros

Descrição

 

pcd-equipto

Código do Equipamento

 

pcd-manut

Código da Manutenção

 

pcd-tarefa

Código da Tarefa da Manutençã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.

getKey

Requisito

Nenhum

Sintaxe

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

                        output <character>,

                        output <integer>).

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

pcd-equipto

Código do Equipamento

 

pcd-manut

Código da Manutenção Padrão

 

pcd-tarefa

Código da Tarefa da Manutençã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.

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 / LinkTo

openQueryDefault

Requisito

Nenhum.

Sintaxe

run openQueryDefault in h-handle.

Descrição

Busca conjunto de registros da tabela mi-eq-tar.

 

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.

afterCreateRecord

Requisito

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

Sintaxe

run afterCreateRecord in this-procedure.

Descrição

Método executado após a atualizaçã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 RowErrors.

getTipoManutencao

Requisito

Nenhum

Sintaxe

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

                                   input <character>,

                                   output <integer>,

                                   output <logical>).

Descrição

Retorna o tipo de manutenção da manutenção\equipamento e se está implantado o módulo de preditiva.

 

Parâmetros

Descrição

 

cCdManut

Manutenção

cCdEquipto

Código do Equipamento

cTipoManut

Tipo Manutenção

lModuloPreditiva

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.

getTecnica

Requisito

Nenhum

Sintaxe

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

                            input <character>,

                            input <integer>,

                            output <character>).

Descrição

Retorna o código da técnica da tarefa do plano manutenção\equipamento.

 

Parâmetros

Descrição

 

p-cdManut

Manutenção

p-cdEquipto

Código do Equipamento

p-cdTarefa

Código da Tarefa

p-cdTecnica

Técnica

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.