BOFR062 - Métodos de manutenção e acesso a tabela de Reserva.

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 “mab-reserva”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

num-reserva

int

>>>>>>>>9

Documento Reserva

Sim

dat-registro

Date

99/99/9999

Data Registro

Sim

hra-registro

Char

99:99:99

Hora Registro

Sim

dat-reserva-inicial

Date

99/99/9999

Data Reserva Inicial

Sim

dat-reserva-final

Date

99/99/9999

Data Reserva Final

Sim

hra-reserva-inicial

Char

99:99:99

Hora Reserva Inicial

Sim

hra-reserva-final

Char

99:99:99

Hora Reserva Final

sim

cod-rota-orig

Char

X(12)

Código Rota Origem

Sim

cod-rota-dest

Char

X(12)

Código Rota Destino

Sim

ep-codigo

Int

>>9

Código Empresa equipamento

Sim

cod-eqpto

Char

X(12)

Código do Equipamento

Sim

cod-matr

Char

X(10)

Código do Motorista

Sim

val-km-estimad

Dec

>,>>>,>>9.9

Uso Estimado

Sim

cod-usuar

Char

X(120

Código do Usuário

dat-atualiz

Date

99/99/9999

Data da atualização

dsl-obs

Char

x(400)

Observação

val-dat-hora-invrtda-inic

Dec

999999999999

Data Hora Invertida Inicial

Sim

val-dat-hora-invrtda-final

Dec

999999999999

Data Hora Invertida Final

sim

cod-livre-1

char

X(100)

Livre 1

cod-livre-2

char

X(100)

Livre 2

log-livre-1

Log

Sim/Não

Livre 1

log-livre-2

Log

Sim/Não

Livre 2

num-livre-1

Int

->>>>>>>>>9

Livre 1

num-livre-2

Int

->>>>>>>>>9

Livre 2

val-livre-1

Dec

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

Livre 1

val-livre-2

Dec

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

Livre 2

dat-livre-1

date

99/99/9999

Livre 1

dat-livre-2

date

99/99/9999

Livre 2

ep-codigo-matr

Int

>>9

Empresa do Motorista

Não

cod-estabel-matr

char

x(3)

Estabelecimento do Motorista

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

Requisito

Nenhum

Sintaxe

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

                         input <character>,

                         input <character>).

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

pcod-comptmento

Código do Compartimento

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

                        output <character>,

                        output <character>).

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

pcod-comptmento

Código do Compartimento

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

Posicionar a query do BO de mab-eqpto no registro desejado.

Sintaxe

run linkToEmpEqpto in h-handle (input <hanlde>).

Descrição

Seta as variáveis de controle para criar o linkTo com a tabela pai “mab-eqpto” os campos ep-codigo e cod-eqpto.

Parâmetros

Descrição

pHandle

Handle BO da tabela 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 RowErrors.

Requisito

Nenhum

Sintaxe

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

                                   input <date>).

Descrição

Carrega as variável com a data da reserva incial para  openQueryData.

Parâmetros

Descrição

pDataIni

Data da reserva incial

pDataFim

Data da reserva 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

Nenhum

Sintaxe

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

                                       input <character>).

Descrição

Carrega as variável com o código da empresa e o código do equipamento  para  openQueryMotoEqpto.

Parâmetros

Descrição

pEmp 

Código da empresa

pEqpto

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

Requisito

Nenhum

Sintaxe

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

                                    input <character>).

Descrição

Carrega as variável com o código do equipamento inicial e final para  openQueryEqpto.

Parâmetros

Descrição

pEqptoIni

Código do equipamento inicial

pEqptoFim

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.

Requisito

Nenhum

Sintaxe

run setConstraintMotorista in h-handle (input <logical>).

Descrição

Carrega a variável com o código do motorista  para  openQueryMotoEqpto.

Parâmetros

Descrição

pMotor

Código do motorista

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 setConstraintNrReserva in h-handle (input <decimal>,

                                        input <decimal>).

Descrição

Carrega as variável com o código do equipamento inicial e final para  openQueryNrReserva.

Parâmetros

Descrição

pReservaIni

Número do documento da reserva inicial

pReservaFim

Número do documento da reserva 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 setConstraintData ter sido executada anteriormente.

Sintaxe

run openQueryData in h-handle.

Descrição

Busca conjunto de registros da tabela mab-reserva com base em uma faixa inicial e final da data da reserva incial. Os registros são ordenados pela data da reserva 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.

Requisito

Executar os métodos setConstraintEqpto.

Sintaxe

run openQueryEqpto in h-handle.

Descrição

Busca conjunto de registros da tabela mab-reserva com base em uma faixa inicial e final da código do equipamento. Os registros são ordenados pelo campo código do equipamento

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

Executar o método setConstraintEmpEqpto e setConstraintMotorista

Sintaxe

run openQueryMotoEqpto in h-handle.

Descrição

Busca conjunto de registros da tabela mab-reserva com base em uma faixa inicial e final da data da reserva incial, mais os campos código da empresa, código do equipamento e código do motorista. Os registros são ordenados pela data da reserva 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.

Requisito

Nenhum

Sintaxe

run openQueryMain in h-handle.

Descrição

Busca conjunto de registros da tabela mab-reserva. Os registros são ordenados pelo documento da reserva.

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

A setConstraintEqpto e setConstraintData ter sido executada anteriormente.

Sintaxe

run openQueryEqptoData in h-handle.

Descrição

Busca conjunto de registros da tabela mab-reserva com base em uma faixa inicial e final da data da reserva incial, mais os campos código da empresa, código do equipamento. Os registros são ordenados pela data hora invertida 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.

Requisito

A setConstraintNrReserva ter sido executada anteriormente.

Sintaxe

run openQueryNrReserva in h-handle.

Descrição

Busca conjunto de registros da tabela mab-reserva com base em uma faixa inicial e final do número da reserva. Os registros são ordenados pelo campo número da reserva.

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 converteParaHoraInvertidaFinal in h-handle (input  <character>,

                                                input  <character>,

                                                output <decimal>).

Descrição

Recebe  a data e a hora da reserva, converte e retorna no formato de data e hora invertida. Para atualizar o campo data e hora invertida final.

Parâmetros

Descrição

pData    

Data corrente do sistema

pHora    

Hora corrente do sistema

pInvertida

Data e hora invertida 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 tt-erro....

Requisito

Nenhum

Sintaxe

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

                                                  input  <character>,

                                                  output <decimal>).

Descrição

Recebe  a data e a hora da reserva, converte e retorna no formato de data e hora invertida. Para atualizar o campo data e hora invertida inicial.

Parâmetros

Descrição

pData    

Data corrente do sistema

pHora    

Hora corrente do sistema

pInvertida

Data e hora invertida 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 tt-erro....

Requisito

Quando for utilizar este método, colocá-lo em uma transação, para que se ocorrer erros, seja desfeita as eliminações

Sintaxe

run EliminaFilhos in h-handle (input <rowid>).

Descrição

Valida e elimina a tabela de Períodos Manutenção Implementos.

Parâmetros

Descrição

pRowid    

Rowid da Tabela de Implementos da Reserva

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

Requisito

Nenhum.

Sintaxe

run buscaNrReserva in h-handle (output {&ttTable}).

Descrição

Busca automática pela numeração da próxima reserva. Recebe como parâmetro para retorno o número do próximo documento da reserva

Parâmetros

Descrição

pNrReserva

Número do documento da reserva

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