Linha Datasul

Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 mnbo/bomn260.p

 

Objetivo

Incluir, atualizar, consultar e eliminar dados da tabela mi-layout-import do aplicativo de manutenção industrial.

 

Funcionamento

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

A sintaxe para a chamada da API/BO é:

run mnbo/bomn260.p.

 

A sintaxe para executar a API/BO em modo persistente é:

run mnbo/bomn260.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 API.

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária

Descrição

Entrada/Saída

RowObject

Tabela de comunicação entre interface e banco de dados da tabela mi-layout-import.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-prog-import

Character

X(8)

Programa Importador

Sim

 

nom-bd

Character

X(32)

Banco Dados

Sim

 

nom-tabela

Character

X(40)

Nome Tabela

Sim

 

num-seq

Integer

>>,>>9

Nr Sequência

Sim

 

nom-campo

Character

X(100)

Nome Campo

Não

 

num-tam-campo

Integer

>>9

Tamanho

Não

 

num-pos-inicial

Integer

>>>9

Posição Inicial

Não

 

num-pos-final

Integer

>>>9

Posição Final

Não

 

cod-tip-dado

Character

X(12)

Tipo Dado

Não

 

qti-casas-dec

Integer

>9

Quantidade Decimais

Não

 

log-mandatorio

Logical

Sim/Não

Mandatório

Não

 

Cod-livre-1

Character

X(100)

Livre 1

Não

 

Cod-livre-2

Character

X(100)

Livre 2

Não

 

Cod-livre-3

Character

X(100)

Livre 3

Não

 

Cod-livre-4

Character

X(100)

Livre 4

Não

 

Dat-livre-1

Date

99/99/9999

Livre 1

Não

 

Dat-livre-2

Date

99/99/9999

Livre 2

Não

 

Dat-livre-3

Date

99/99/9999

Livre 3

Não

 

Dat-livre-4

Date

99/99/9999

Livre 4

Não

 

log-livre-1

Logical

Sim/Não

Livre 1

Não

 

log-livre-2

Logical

Sim/Não

Livre 2

Não

 

log-livre-3

Logical

Sim/Não

Livre 3

Não

 

log-livre-4

Logical

Sim/Não

Livre 4

Não

 

Num-livre-1

Integer

>>>>>>>>9

Livre 1

Não

 

Num-livre-2

Integer

>>>>>>>>9

Livre 2

Não

 

Num-livre-3

Integer

>>>>>>>>9

Livre 3

Não

 

Num-livre-4

Integer

>>>>>>>>9

Livre 4

Não

 

Val-livre-1

Decimal

->>>>>>>>>>>9.99999999

Livre 1

Não

 

Val-livre-2

Decimal

->>>>>>>>>>>9.99999999

Livre 2

Não

 

Val-livre-3

Decimal

->>>>>>>>>>>9.99999999

Livre 3

Não

 

Val-livre-4

Decimal

->>>>>>>>>>>9.99999999

Livre 4

Não

 

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

Descrição

Posiciona o registro da mi-layout-import através do código da função.

 

Parâmetros

Descrição

 

pcod-prog-import

Programa Importador

 

pnom-bd

Banco Dados

 

pnom-tabela

Nome Tabela

 

pnum-seq

Nr Sequência

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 do registro posicionado.

 

Parâmetros

Descrição

 

pcod-prog-import

Programa Importador

 

pnom-bd

Banco Dados

 

pnom-tabela

Nome Tabela

 

pnum-seq

Nr Sequência

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

 

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

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