Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 mnbo/bomn244.p

Objetivo

Validação dos dados de parametrização das Integrações do módulo de Manutenção Industrial na tabela mi-param-extens.

Funcionamento

 

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

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

A sintaxe para a chamada BO é:

run mnbo\bomn244.p.

 

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run mnbo\bomn244.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-param-extens”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

Cdn-param

Int

>>9

Parâmetro

Sim  /  Key

001

des-param

char

x(256)

Observação

Não

001

Des-label-param

char

x(50)

Descrição

Não

001

Des-valor

char

x(50)

Valor do Parâmetro

Não

001

Cod-livre-1

Char

X(100)

Character Livre

Não

001

Cod-livre-2

Char

X(100)

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

Decimal Livre

Não

001

Val-livre-2

Dec

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

Decimal Livre

Não

001

Dat-livre-1

Date

99/99/9999

Date Livre

Não

001

Dat-livre-2

Date

99/99/9999

Date Livre

Não

001

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

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

 

Métodos Básicos

 

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

 

    

getKey

Requisito

Nenhum

 

Sintaxe

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

                        output <character>,

                        output <character>,

                        output <character>).

 

Descrição

Retorna os campos da chave primária da tabela.

 

 

Parâmetros

Descrição

 

Pcdn-param

Parâmetro

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.

 

    

goToKey

Requisito

Nenhum

 

Sintaxe

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

                         input <character>,

                         input <character>,

                         input <character>).

 

Descrição

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

 

 

Parâmetros

Descrição

 

Pcdn-param

Parâmetro

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.

 

    

Métodos de 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.

 

    

 

atualizaValor1

Requisito

Nenhum.

 

Sintaxe

run atualizaValor1 in this-procedure (input <integer>,

                                      input <character>,

                                      input <character>,

                                      input <character>).

 

Descrição

Valida se o valor é consistente e então atualiza este.

 

 

Parâmetros

Descrição

 

pCod

Parâmetro

pLabel

Observação

pDes

Descrição

pValor

Valor do Parâmetro

Retorno

Se houverem erros durante a execução do método estes serão especificados na temp-table RowErrors.

 

    

 

validaParametros

Requisito

Ser validada pelo método validateRecord.

 

Sintaxe

RUN validaParametros IN THIS-PROCEDURE (INPUT rowObject.cdn-param,

                                        INPUT rowObject.des-valor).

 

Descrição

Faz a validação dos parâmetros utilizados na BO.

 

 

Parâmetros

Descrição

 

pParam

Parâmetro

 

pValor

Valor do parâmetro

Retorno

Se houverem erros durante a execução do método estes serão especificados na temp-table RowErrors.