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

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ep-codigo

Int

>>9

Código da empresa do equipamento

Sim

cod-eqpto

Char

x(16)

Código do equipamento

Sim

dat-movto

Date

99/99/9999

Data do Movimento

Sim

cod-estabel

Char

x(3)

Código do Estabelecimento.

Sim

val-hora-manut

Dec

>>,>>9.99

Horas Manutenção

val-hora-reporte

Dec

>>,>>9.99

Horas reportadas pelos funcionários manutenção

val-km-percur

Dec

>,>>>,>>9.9

Indica o total do percurso realizado

val-quant-combust

Dec

>>>,>>>,>>9.99

Quantidade Combustível

val-ggf-1-corren

Dec

>,>>>,>>9.99

Gasto GGF 1 Moeda Corrente

val-ggf-1-moed-1

Dec

>>,>>>,>>9.99

Valor GGF 1 - moeda alternativa 1

Sim

val-ggf-1-moed-2

Dec

>>,>>>,>>9.99

Valor GGF 1 - moeda alternativa 2

val-ggf-2-corren

Dec

>>,>>>,>>9.99

Valor GGF 2 - moeda corrente

Sim

val-ggf-2-moed-1

Dec

>>,>>>,>>9.99

Valor GGF 2 - moeda alternativa 1

val-ggf-2-moed-2

Dec

>>,>>>,>>>,>>9.99

Valor GGF 2 - moeda alternativa 2

val-ggf-3-corren

Dec

>>,>>>,>>9.99

Valor GGF 3 - moeda corrente

val-ggf-3-moed-1

Dec

>>,>>>,>>9.99

Valor GGF 3 - moeda alternativa 1

Sim

val-ggf-3-moed-2

Dec

>>,>>>,>>9.99

Valor GGF 3 - moeda alternativa 2

val-ggf-4-corren

Dec

>>,>>>,>>9.99

Valor GGF 4 - moeda corrente

val-ggf-4-moed-1

Dec

>>,>>>,>>9.99

Valor GGF 4 - moeda alternativa 1

val-ggf-4-moed-2

Dec

>>,>>>,>>9.99

Valor GGF 4 - moeda alternativa 2

val-ggf-5-corren

Dec

>>,>>>,>>9.99

Valor GGF 5 - moeda corrente

val-ggf-5-moed-1

Dec

>>,>>>,>>9.99

Valor GGF 5 - moeda alternativa 1

val-ggf-5-moed-2

Dec

>>,>>>,>>9.99

Valor GGF 5 - moeda alternativa 2

val-ggf-6-corren

Dec

>>,>>>,>>9.99

Valor GGF 6 - moeda corrente

val-ggf-6-moed-1

Dec

>>,>>>,>>9.99

Valor GGF 6 - moeda alternativa 1

val-ggf-6-moed-2

Dec

>>,>>>,>>9.99

Valor GGF 6 - moeda alternativa 2

val-mdo-corren

Dec

->>,>>>,>>9.99

Valor mão-de-obra direta - moeda corrente

val-mdo-moed-1

Dec

->>,>>>,>>9.99

Valor mão-de-obra direta - moeda alternativa 1

val-mdo-moed-2

Dec

->>,>>>,>>9.99

Valor mão-de-obra direta - moeda alternativa 2

val-nota-corren

Dec

->>>,>>>,>>9.99

Valor Nota Fiscal - moeda corrente

val-nota-moed-1

Dec

->>>,>>>,>>9.99

Valor Nota Fiscal - moeda alternativa 1

val-nota-moed-2

Dec

->>>,>>>,>>9.99

Valor Nota Fiscal - moeda alternativa 2

val-item-corren

Dec

->>>,>>>,>>9.99

Valor item - moeda corrente

val-item-moed-1

Dec

->>>,>>>,>>9.99

Valor item - moeda alternativa 1

val-item-moed-2

Dec

->>>,>>>,>>9.99

Valor Item - moeda alternativa 2

val-quant-transp

Dec

>,>>>,>>9.99

Quantidade Transportada

num-viagem

Int

>>,>>9

Número de Viagens

val-combust-corren

Dec

>>>,>>>,>>9.99

Valor Total combustível na Moeda Corrente

val-combust-moed-1

Dec

>>>,>>>,>>9.99

Valor Combustível na moeda alternativa 1

val-combust-moed-2

Dec

>>>,>>>,>>9.99

Valor Total de Combustível na moeda alternativa 2

val-lubrific-corren

Dec

>>>,>>>,>>9.99

Valor de lubrificantes na moeda corrente

val-lubrific-moed-1

Dec

>>>,>>>,>>9.99

Valor de lubrificantes na moeda alternativa 1

val-lubrific-moed-2

Dec

>>>,>>>,>>9.99

Valor de lubrificantes na moeda alternativa 2

val-filtro-corren

Dec

>>>,>>>,>>9.99

Valor Total de filtros na moeda corrente

val-filtro-moed-1

Dec

>>>,>>>,>>9.99

Valor total de filtros na moeda alternativa 1

val-filtro-moed-2

Dec

>>>,>>>,>>9.99

Valor dos filtros gastos na moeda alternativa 2

val-pneu-corren

Dec

>>>,>>>,>>9.99

Valor total de pneus na moeda corrente

val-pneu-moed-1

Dec

>>>,>>>,>>9.99

Valor de Pneus na moeda alternativa 1

Sim

val-pneu-moed-2

Dec

>>>,>>>,>>9.99

Valor de Pneus na Moeda Alternativa 2

Sim

val-serv-corren

Dec

>>>,>>>,>>9.99

Valor dos serviços realizados por terceiros

Sim

val-serv-moed-1

Dec

>>>,>>>,>>9.99

Valor serviço terceiros na moeda alternativa 1

Sim

val-serv-moed-2

Dec

>>>,>>>,>>9.99

Valor serviço terceiros na moeda alternativa 2

Sim

val-deprec-corren

Dec

>>>,>>>,>>9.99

Valor total da deperciação na moeda corrente

val-deprec-moed-1

Dec

>>>,>>>,>>9.99

Valor total da deperciação na moeda 1

val-deprec-moed-2

Dec

>>>,>>>,>>9.99

Valor total da deperciação na moeda 2

cod-livre-1

Char

x(100)

Character Livre

cod-livre-2

Char

x(100)

Character Livre

log-livre-1

Log

Sim/Não

Logical Livre

log-livre-2

Log

Sim/Não

Logical Livre

num-livre-1

Int

->>>>>>>>9

Inteiro Livre

num-livre-2

Int

->>>>>>>>9

Inteiro Livre

val-livre-1

Dec

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

Decimal Livre

val-livre-2

Dec

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

Decimal Livre

dat-livre-1

Date

99/99/9999

Data Livre

dat-livre-2

Date

99/99/9999

Data Livre

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

Requisito

Nenhum

Sintaxe

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

                         input <character>,

                         input <date>,

                         input <character>).

Descrição

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

Parâmetros

Descrição

pep-codigo

recebe valor do campo ep-codigo

pcod-evento

recebe valor do campo cod-evento

pdat-movto

recebe valor do campo dat-movto

pcod-estabel

recebe valor do campo cod-estabel

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 (input <integer>,

                        input <character>,

                        input <date>,

                        input <character>).

Descrição

Retorna os campos da chave primária da tabela.

Parâmetros

Descrição

pep-codigo

recebe valor do campo ep-codigo

pcod-evento

recebe valor do campo cod-evento

pdat-movto

recebe valor do campo dat-movto

pcod-estabel

recebe valor do campo cod-estabel

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 setConstraintCusto in h-handle (input <integer>,

                                    input <integer>,

                                    input <character>,

                                    input <character>,

                                    input <date>,

                                    input <date>,

                                    input <character>,

                                    input <character>).

Descrição

Recebe as faixas da Chave primária da tabela.

Parâmetros

Descrição

pi-ep-codigo-ini

Código da Empresa Inicial

pi-ep-codigo-fim

Código da Empresa Final

pc-cod-eqpto-ini

Código do Equipamento Inicial

pc-cod-eqpto-fim

Código do Equipamento Final

pdt-dat-movto-ini

Data do Movimento Inicial

pdt-dat-movto-fim

Data do Movimento Final

pc-cod-estabel-ini

Código do Estabelecimento Inicial

pc-cod-estabel-fim

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

Requisito

A setConstraintCusto ter sido executada anteriormente.

Sintaxe

run openQueryCusto in h-handle.

Descrição

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.

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.

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.

Requisito

Nenhum         

Sintaxe

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

                                    input <character>,

                                    input <character>,

                                    input <decimal>,

                                    input <decimal>,

                                    input <decimal>).

Descrição

Atualiza Valores de Depreciação por Grupo de Equipamento.

Parâmetros

Descrição

pc-cod-grp-eqpto

Código do Grupo de Equipamento

pc-cod-estabel

Código do Estabelecimento

pc-dat-movto

Data do Movimento

pde-val-corren

Valor total da depreciação na moeda corrente

pde-val-moed-1

Valor total da depreciação na moeda 1

pde-val-moed-2

Valor total da depreciação na moeda 2