Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr076


Objetivo

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


Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr071.p.


A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr071.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-movto-mater”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

dat-movto

date

99/99/9999

Data Movimento

Sim

001

idi-espec-docto

int 

9

Espécie Documento

Sim

001

nro-docto

char

X(16)

Número da Nota Fiscal ou número da Requisição

Não

001

serie-docto

char

X(5)

Série NF

Não

001

sequencia

int

>>.>>>

Seqüência Item NF

Não

001

nr-ord-produ

int

>>>,>>>,>>9

Número da Ordem Manutenção

Não

001

num-seq

int

>>.>>9

Tarefa Ordem Manutenção

Não

001

ep-codigo

int

>>> 

Código Empresa

Não

001

cod-eqpto

char

X(16)

Código Equipamento

Não

001

cod-placa

char

X(12)

Código licença Equipamento

Não

001

cod-renavam

char

X(16)

Código Renavam

Não

001

cod-chassi

char

X(20)

Código Chassi

Não

001

it-codigo

char

X(16)

Código Item

Sim

001

log-saida

int

9

Indicador Saída ou Entrada

Não

001

cod-evento

char

X(8)

Código Evento

Não

001

qtd-item

Dec

->>>.>>>.>>9,9999

Quantidade Item

Não

001

val-mater-1

Dec

->>>.>>>.>>9,9999

Valor Item

Sim

001

ge-codigo

Int

>9

Código Grupo Estoque Item

Não

001

dsl-obs

Char

X(2000)

Observação

Não

001

Num-seqcial

Int

>>>>>>>>9

Número da seqüência

Não

001

Esp-docto

Int

>9

Espécie do Documento

Não

001

Val-mater-2

Dec

->>>.>>>.>>9,9999

Valor alternativo 2

Não

001

Val-mater-3

Dec

->>>.>>>.>>9,9999

Valor alternativo 3

Não

001

Nr-trans

Int

>>>,>>>,>>9

Número do transporte

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

                         input <character>,

                         input <date>).

Descrição

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

 

Parâmetros

Descrição

 

 

Pep-codigo

Código da Empresa

 

Pcod-eqpto

Código do Equipamento

 

Pdat-movto

Data de 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 RowErrors.

getKey

Requisito

Nenhum

Sintaxe

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

                        input <character>,

                        input <date>).

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

Pep-codigo

Código da Empresa

 

Pcod-eqpto

Código do Equipamento

 

Pdat-movto

Data de 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 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

linkToOM    

Requisito

Nenhum

Sintaxe

run linkToOM in h-handle (input <handle>.

Descrição

Busca o documento do apontamento e seta as restrições para abertura da query.

 

Parâmetros

Descrição

 

pHandle

Handle da DBO de Apontamento

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.

setConstraintDocumento

Requisito

Nenhum

Sintaxe

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

                                        input <date>,

                                        input <character>,

                                        input <character>,

                                        input <integer>,

                                        input <integer>).

Descrição

Seta as restrições para abrir a query por faixa de Data de Movimento,  Documento e Ordem do Documento.

 

Parâmetros

Descrição

 

PdatmovtoIni

Data de Movimento Inicial

 

PdatMovtoFim

Data de Movimento Final

 

PnroDoctoIni

Número do Documento Inicial

 

PnroDoctoFim

Número do Documento Final

 

PnrOrdProdu Ini

Ordem de Produto Inicial

 

PnrOrdProduFim

Ordem de Produto Fim

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.

setConstraintEmpresa

Requisito

Nenhum

Sintaxe

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

                                        input <date>,

                                        input <integer>,

                                        input <integer>,

                                        input <character>,

                                        input <character>).

Descrição

Seta as restrições para abrir a query por faixa de Data de Manutenção, Código da Empresa e Código do Equipamento.

 

Parâmetros

Descrição

 

PdatmovtoIni

Data de Movimento Inicial

 

PdatMovtoFim

Data de Movimento Final

 

PepCodigoIni

Código da Empresa Inicial

 

PepCodigo Fim

Código da Empresa final

 

PcodEqptoIni

Código do Equipamento Inicial

 

PcodEqpto Fim

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

setConstraintOM

Requisito

Nenhum

Sintaxe

run setConstraintOM in h-handle (input <integer>).

Descrição

Seta as restrições para abrir a query pelo número da ordem de produto inicial.

 

Parâmetros

Descrição

 

PNrOrdProduIni

Número Ordem de Produto Inicial

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.

openQueryDocumento

Requisito

A setConstraintDocumento ter sido executada anteriormente.

Sintaxe

Run openQueryDocumento in h-handle.

Descrição

Abre a query da BO conforme a faixa Data de Movimento, Número e Ordem do Documento passada na procedure setConstraintDocumento.

 

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.

openQueryEmpresa

Requisito

A setConstraintEmpresa terem sido executadas anteriormente.

Sintaxe

run openQueryEmpresa in h-handle.

Descrição

Abre a query da BO conforme a faixa Data de Movimento, Código da Emnpresa e Código do Equipamento passados na procedure setConstraintFiltro.

 

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.

openQueryOM

Requisito

A setConstraintOM terem sido executadas anteriormente.

Sintaxe

run openQueryOM in h-handle.

Descrição

Abre a query da BO conforme o número da ordem de produto inicial.

 

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.

atualizaCampos

Requisito

Nenhum.

Sintaxe

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

                                input  <character>

                                output <character.).

Descrição

Busca a descrição dos campos que fizeram a chamada a essa procedure.

 

Parâmetros

Descrição

 

Pcod

Código do Campo que chamou a Procedure

 

Pdes

Tipo do Campo

 

Ptip

Descrição 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 tt-erro....

createMovtoMater

Requisito

Nenhum.

Sintaxe

run createMovtoMater in this-procedure.

Descrição

Cria um novo registro para a tabela mmv-movto-mater.

 

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

descEqpto              

Requisito

Nenhum.

Sintaxe

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

                           input  <character>,

                           output <character>).

Descrição

Busca a descrição do Módulo do Equipamento.

 

Parâmetros

Descrição

 

PEmpre

Código da Empresa

 

PEqpto

Código do Equipamento

 

PDes

Descrição do Módulo de Equipamento

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

verificaOrdem

Requisito

Nenhum

Sintaxe

Run verificaOrdem in h-handle (input  <character>,

                               output <integer>,

                               output <character>).

Descrição

Valida o campo Ordem de Manutenção.

 

Parâmetros

Descrição

 

Pmanut

Código da Ordem de Manutenção

 

Pempre

Código da Empresa

 

Pequip

Código do Equipamento

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