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 “mco-movto-compon”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

num-docto

int

>>>,>>>,>>9

Número Documento

Sim  /  Key

001

num-seqcial

int

>>>>>>>>9

Número Seqüencial do Componente

Sim

001

cod-sub-sist

char

x(8)

Código do Sub-Sistema

Não

001

cod-compon

char

x(16)

Código do Componente

Não

001

val-dat-hora-invrtda

dec

999999999999

Valor da Data e Hora Invertidas do Apontamento

Sim

001

dat-movto

date

99/99/9999

Data do Movimento

Sim

001

hra-movto

char

99:99:99

Hora do Movimento

Sim

001

ep-codigo

int

>>9

Código da Empresa

Não

001

cod-eqpto

char

x(16)

Código do Equipamento

Não

001

cod-estabel

char

x(3)

Código do Estabelecimento

Não

001

cod-evento

char

x(8)

Código do Evento

Não

001

cod-localiz-compon

char

x(15)

Localização do Componente

Não

001

idi-tip-movto

int

99

Tipo de Movimento:

1 – Retirada

2 - Colocação

3 - Transferência

4 - Reforma

Sim

001

nr-ord-produ

int

>>>,>>>,>>9

Número Ordem Manutenção

Sim

001

num-seq

int

>>,>>9

Número da Tarefa da OM

Sim

001

cod-sit-eqpto

char

x(8)

Código Situação do Componente

Sim

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

cc-codigo

char

x(20)

Centro Custo

Não

001

cod-usuar

char

x(12)

Código Usuário

Não

001

cod-causa-padr

char

x(8)

Causa Padrão

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

Descrição

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

Parâmetros

Descrição

pnum-docto

Número do Documento

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

Descrição

Retorna os campos da chave primária da tabela.

Parâmetros

Descrição

pnum-docto

Número do Documento

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 mco-movto-compon no registro desejado.

Sintaxe

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

Descrição

Seta as variáveis de controle para criar o linkTo com a tabela pai “mco-movto-compon ” o campo número sequencial.

Parâmetros

Descrição

pHandle

Handle BO da tabela viagem    

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 setConstraintCO0606 in h-handle (input <date>,

                                         input <date>,

                                         input <character>,

                                         input <character>).

Descrição

Seta as restrições para componente.

Parâmetros

Descrição

pDataIni     

Data inicial

pDataFim     

Data final

pEventoIni   

Evento inicial

pEventoFim   

Evento final

pHoraIni     

Horário inicial

pHoraFim     

Horário final

pEpCodigoIni 

Código empresa inicial

pEpCodigoFim 

Código empresa final

pCodEqptoIni 

Código equipamento inicial

pCodEqptoFim 

Código equipamento final

pCodEstabelIni

Código estabelecimento inicial

pCodEstabelFim

Código 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

Nenhum

Sintaxe

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

                                         input <character>,

                                         input <character>,

                                         input <character>).

Descrição

Seta as restrições para abrir a query por faixa de componente.

Parâmetros

Descrição

pSubIni

Código Sub-Sistema Inicial

pSubFim

Código Sub-Sistema Final

pCompIni

Código Componente Inicial

pCompFim

Código Componente 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 setConstraintData in h-handle (input <date>,

                                   input <date>).

Descrição

Seta as restrições para abrir a query por faixa de data de movimento de componentes.

Parâmetros

Descrição

pDataIni

Data Movimento Inicial

pDataFim

Data Movimento 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 setConstraintDocumento in h-handle (input <integer>,

                                        input <integer>).

Descrição

Seta as restrições para abrir a query por faixa de número do documento do apontamento.

Parâmetros

Descrição

pDocIni

Número Documento Inicial

pDocFim

Número Documento 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 setConstraintTipo in h-handle (input <logical>,

                                   input <logical>,

                                   input <logical>,

                                   input <logical>).

Descrição

Seta as restrições para abrir a query por tipo de movimento de componente.

Parâmetros

Descrição

pRetirada

Movimento de Retirada do Componente

pColocacao

Movimento de Colocação do Componente

pTransfere

Movimento de Transferência de Componente

pReforma

Movimento de Reforma de Componente

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 setConstraintmco-compon in h-handle (input <integer).

Descrição

Seta as restrições para abrir a query pelo número sequencial.

Parâmetros

Descrição

pNumSeqcial

Número sequencial

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 setConstraintCO0606 ter sido executada anteriormente.

Sintaxe

run openQueryCO0606 in h-handle.

Descrição

Abre a query com os registros por restrição de data do apontamento.

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 setConstraintComponente ter sido executada anteriormente.

Sintaxe

run openQueryComponente in h-handle.

Descrição

Abre a query da BO conforme a faixa de componentes passada na procedure setConstraintComponente.

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 setConstraintComponente e a setConstraintTipo terem sido executadas anteriormente.

Sintaxe

run openQueryComponenteFiltro in h-handle.

Descrição

Abre a query da BO conforme a faixa de componentes passada na procedure setConstraintComponente e utilizando o filtro de tipo de movimento da procedure setConstraintTipo.

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 setConstraintData ter sido executada anteriormente.

Sintaxe

run openQueryData in h-handle.

Descrição

Abre a query da BO conforme a faixa de data de movimento passada na procedure setConstraintData.

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 setConstraintData e a setConstraintTipo terem sido executadas anteriormente.

Sintaxe

run openQueryDataFiltro in h-handle.

Descrição

Abre a query da BO conforme a faixa de data de movimento passada na procedure setConstraintData e utilizando o filtro de tipo de movimento da procedure setConstraintTipo.

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 setConstraintDocumento ter sido executada anteriormente.

Sintaxe

run openQueryDocumento in h-handle.

Descrição

Abre a query da BO conforme a faixa de número do documento passada na procedure setConstraintDocumento.

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 setConstraintDocumento e a setConstraintTipo terem sido executadas anteriormente.

Sintaxe

run openQueryDocumentoFiltro in h-handle.

Descrição

Abre a query da BO conforme a faixa de número do documento passada na procedure setConstraintDocumento e utilizando o filtro de tipo de movimento da procedure setConstraintTipo.

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

A setConstraintmco-compon ter sido executadas anteriormente.

Sintaxe

run openQueryNumSeqcial in h-handle.

Descrição

Abre a query da BO conforme o número sequencial.

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 openQueryDefault in h-handle.

Descrição

Realiza a abertura da query da BO.

Parâmetros

Descrição

Não Contem

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

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

Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.

Sintaxe

run validate in this-procedure.

Descrição

Faz validações de Componente e Sub-Sistema.

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

Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.

Sintaxe

run validaColocacao in this-procedure.

Descrição

Faz as validações para quando o tipo de apontamento for de Colocação (2).

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

Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.

Sintaxe

run validaRetirada in this-procedure.

Descrição

Faz as validações para quando o tipo de apontamento for de Retirada (1).

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

Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.

Sintaxe

run validaTransferencia in this-procedure.

Descrição

Faz as validações para quando o tipo de apontamento for de Transferência (3).

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

Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.

Sintaxe

run afterCreateRecord in this-procedure.

Descrição

Chama a procedure buscaCompoente, a qual verifica qual o tipo de apontamento que foi manutenido e atualiza o cadastro de Componentes.

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

Requisito

Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.

Sintaxe

run afterDeleteRecord in this-procedure.

Descrição

Chama a procedure buscaCompoente, a qual verifica qual o tipo de apontamento que foi manutenido e atualiza o cadastro de Componentes.

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

Requisito

Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.

Sintaxe

run afterUpdateRecord in this-procedure.

Descrição

Chama a procedure buscaCompoente, a qual verifica qual o tipo de apontamento que foi manutenido e atualiza o cadastro de Componentes.

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

Requisito

Procedure chamada pelos métodos afterCreateRecord, afterDeleteRecord e afterUpdateRecord. Não deve ser chamada externamente.

Sintaxe

run buscaComponente in this-procedure.

Descrição

Verifica qual o tipo de apontamento e chama a procedure atualizaComponente para os tipo 1, 2 e 3. Para o tipo 4, chama a procedure atualizaVida.

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

Requisito

Procedure chamada pelo método buscaComponente. Não deve ser chamada externamente.

Sintaxe

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

                                          input <character>,

                                          input <character>,

                                          input <character>,

                                          input <character>,

                                          input <date>,

                                          input <integer>,

                                          input <character>,

                                          input <character>,

                                          input <character>).

Descrição

Atualiza os dados passados como parâmetro no cadastro de componente.

Parâmetros

Descrição

pEmp

Código da Empresa

pEqpto

Código do Equipamento

pEstab

Código do Estabelecimento

pSit

Código da Situação do Componente

pLocal

Código da Localização

pData

Data de Atualização do Componente

pVida

Número da Vida do Componente.

pCCusto

Centro de Custo Atual

pCausa

Código da Causa da Desativação

pUn

Código da Unidade de Negócio

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

Procedure chamada pelo método buscaComponente. Não deve ser chamada externamente.

Sintaxe

run atualizaVida in this-procedure.

Descrição

Verifica se a reforma ocorrida gerou uma vida que deve ser adicionada ao histórico de vida do componente.

Chama a procedure atualizaComponente para atualizar os dados da reforma no cadastro do componente.

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

Requisito

Nenhum

Sintaxe

run criaErros in h-handle (input table RowErrors).

Descrição

Recebe os erros ocorridos na BO, criados por outras BOs, com mais agilidade.

Parâmetros

Descrição

RowErrors

Temp-Table de erros padrão do Template.

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 manutMovimentos in h-handle (input table RowObject,

                                 input <character>).

Descrição

Percorre a temp-table RowObject e executa a ação passada: CREATE, UPDATE ou DELETE. Faz as validações, chamando a validateRecord.

Parâmetros

Descrição

RowObject

Temp-Table comunicação da tabela mco-movto-compon (Movimentos de Componentes)

pAcao

Ação a ser feita pela procedure: CREATE, UPDATE ou 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 tt-erro....

Requisito

Nenhum

Sintaxe

run buscaDocumento in h-handle (output <integer>).

Descrição

Busca o próximo número de apontamento de movimento de pneus que deve ser incluído.

Parâmetros

Descrição

pDoc

Número Documento

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 chamaAPIDurabilidade in h-handle (output <integer>).

Descrição

Cria os movimentos de Componentes para a Ordem de Manutençã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 tt-erro....

Requisito

Nenhum

Sintaxe

run criaMovimentoCompon in h-handle.

Descrição

Cria/Modifica os movimentos em batch.

Parâmetros

Descrição

RowObjectB

temp-table RowObject

pAcao

Ação feita pelo usuário

("ADD", "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 tt-erro....

Requisito

Nenhum

Sintaxe

run eliminaVidaCompon in h-handle.

Descrição

Elimina a vida do componente criada pelo movimento de reforma do componente.

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

Requisito

Nenhum

Sintaxe

run setaPrograma in h-handle (input <character>).

Descrição

Seta o programa chamador para determinadas validações.

Parâmetros

Descrição

pPrograma

Nome programa

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 piAcertaCamposLivres in h-handle.

Descrição

Realiza a gravação do conteúdo de campos livres nos seus devidos campos criado. Obs.: Executado somente em Metadados.

Parâmetros

Descrição

Não Contem

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

                                         output <character>,

                                         output <character>,

                                         output <character>,

                                         output <character>,

                                         output <character>,

                                         output <character>,

                                         output <character>,

                                         output <character>).

Descrição

Retorna informações do componente.

Parâmetros

Descrição

piNumSeqcial

Código Sequencial do Componente

pcCodSubSistema

Código do Sub-sistema

pcCodCompon

Código do Componente

pcDesModel

Descrição do Modelo do Componente

pcCodLocalizCompon

Localização do Componente

pcEpCodigoAtual

Código da Empresa Atual

pcCodEqptoAtual

Código do Equipamento Atual

pcCodEstabelAtual

Código do Estabelecimento Atual

pcCodUnidNegoc

Código da Unidade de Negócio

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.

Código da Unidade de Negócio

Requisito

Nenhum

Sintaxe

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

                                   output <character>).

Descrição

Retorna a data e hora corrente.

Parâmetros

Descrição

pdDataAtual

Data Atual

pcHoraAtual

Hora Atual

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 piRetornaUsuario in h-handle (output <character>).

Descrição

Retorna o usuário corrente.

Parâmetros

Descrição

pcUsuarioPadrao

Usuário Padrão

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

                                        input <character>,

                                        output <character>,

                                        output <character>,

                                        output <character>,

                                        output <character>).

Descrição

Retorna informações referente ao Equipamento.

Parâmetros

Descrição

pcEpCodigo

Código da Empresa

pcCodEqpto

Código do Equipamento

pcCodEstabel

Código do Estabelecimento

pcCentroCustoEqpto

Centro de Custo Equipamento

pcCentroCustoManut

Centro de Custo Manutenção

pcCodUnidNegoc

Código da Unidade de Negócio

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 setRecebimento in h-handle (input <logical>).

Descrição

Chamado pela coapi003 para informar se é recebimento.

Parâmetros

Descrição

plRecebimento

Variável lógica.

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.