Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

Tabela Temporária

Descrição

Entrada/Saída

RowObject

Tabela de comunicação entre Interface e banco de dados da tabela “mgf-cust-item-estoq”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

It-codigo

char

X(16)

Item

Sim  /  Key

001

Cod-estabel

char

x(03)

Estabelecimento

Sim  /  Key

001

Dat-movto

Date

99/99/9999

Data Movimento

Sim  /  Key

001

Val-mater-1

dec

>>>,>>>,>>9.9999

Valor do Material na moeda oficial

Não

001

Val-mater-2

dec

>>>,>>>,>>9.9999

Valor Material na moeda alternativa 1

Não

001

Val-mater-3

dec

>>>,>>>,>>9.9999

Valor Material Moeda Alternativa 2

Não

001

cod-livre-1

char

x(1000)

Character Livre

Não

001

cod-livre-2

Char

x(1000)

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

Decimal Livre

Não

001

val-livre-2

dec

->>>>>>>>>>>9.9

Decimal Livre

Não

001

dat-livre-1

date

99/99/9999

Data livre

Não

001

dat-livre-2

date

99/99/9999

Data 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

Requisito

Nenhum

Sintaxe

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

                         input <character>,

                         input <character>,

                         input <integer>).

Descrição

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

Parâmetros

Descrição

pcod-prog-import

Código do programa importador

pnom-bd

Nome do banco de dados

pnom-tabela

Nome da tabela

pnum-seq

Seqüência 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.

Requisito

Nenhum

Sintaxe

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

                        output <character>,

                        output <character>,

                        output <integer>).

Descrição

Retorna os campos da chave primária da tabela.

Parâmetros

Descrição

pcod-prog-import

Código do programa importador

pnom-bd

Nome do banco de dados

pnom-tabela

Nome da tabela

pnum-seq

Seqüência 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.

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.

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.

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.

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.

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.

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.

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.

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.

Requisito

Nenhum

Sintaxe

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

                                   input <character>,

                                   input  <character

                                   input  <character>

                                   input  <date>,

                                   input  <date>).

Descrição

Seta as restrições para abrir a query por faixa de código do Item, código do estabelecimento e data do movimento.

Parâmetros

Descrição

pItemIni

Código inicial do Item

pItemFim

Código final do Item

pEstabIni

Código inicial do Estabelecimento

pEstabFim

Código final do estabelecimento

pDateIni

Data inicial

pDateIni

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

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

Requisito

A setConstraintEquipamento e a setConstraintFiltro  terem sido executadas anteriormente.

Sintaxe

run openQueryEquipamentoItemh-handle.

Descrição

Abre a query da BO conforme a faixa de Código do Item, código do estabelecimento e data do movimento.

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

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 criação são especificados na temp-table RowErrors.

Requisito

Enviar o registro contendo informações para criação da tabela “mgf-cust-item-estoq”.

Sintaxe

run createMGFCustItemEstoq in <handle> (input table <RowObject>).

Descrição

Valida a ação de “CREATE” da BO.

Parâmetros

Descrição

RowObject

Tabela com o(s) registro(s) para criar a “mgf-cust-item-estoq”

Retorno

A 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, que podem ser retornados através do método “getErrors” que está documentado a seguir.

Requisito

Receber o código do estabelecimento para efetuara busca na tabela.

Sintaxe

run buscaEstab in h-handle (input   pCodEstabel

                            output  pNome).

Descrição

Busca registros na tabela estabelec.

Parâmetros

Descrição

pCodEstabel

Código do estabeleciemnto

pNome

Descrição do estabelecimento.

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