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

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

Código 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 setConstraintDocto in h-handle (input <integer>,

                                   input <integer>,

                                   input <logical>,

                                   input <logical>,

                                   input <logical>,

                                   input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de Código de Documento.

Parâmetros

Descrição

pDoctoIni

Código Documento Inicial

pDoctoFim

Código Documento Final

pAberto

Aberto (Sim\Não)

pTerminado

Terminado (Sim\Não)

pCancelado

Cancelado (Sim\Não)

pSuspenso

Suspenso (Sim\Nã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 RowErrors.

Requisito

Nenhum

Sintaxe

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

                                   input <integer>,

                                   input <integer>,

                                   input <integer>,

                                   input <logical>,

                                   input <logical>

                                   input <logical>,

                                   input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de Código de Empresa e Código de Equipamento.

Parâmetros

Descrição

pEmpIni

Código Empresa Inicial

pEmpFim

Código Empresa Final

pEqptoIni

Código Equipamento Inicial

pEqptoFim

Código Equipamento Final

pAberto

Aberto (Sim\Não)

pTerminado

Terminado (Sim\Não)

pCancelado

Cancelado (Sim\Não)

pSuspenso

Suspenso (Sim\Nã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 RowErrors.

Requisito

Nenhum

Sintaxe

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

                                       input <character>,

                                       input <logical>,

                                       input <logical>,

                                       input <logical>,

                                       input <logical>).

Descrição

Seta as restrições para abrir a query por faixa de Código de Processo.

Parâmetros

Descrição

pProcessoIni

Código do Processo Inicial

pProcessoFim

Código do Processo Final

pAberto

Aberto (Sim\Não)

pTerminado

Terminado (Sim\Não)

pCancelado

Cancelado (Sim\Não)

pSuspenso

Suspenso (Sim\Nã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 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.

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

Sintaxe

run openQuerydocto in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código de Documento.

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

Sintaxe

run openQueryEquipamento in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código de 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

A setConstraintProcess ter sido executada anteriormente.

Sintaxe

run openQueryProcess in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código de Processo.

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

Descrição

Realiza override após criação de algum registro.

Parâmetros

Descrição

Nenhum

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 createRecord. Não deve ser chamada externamente.

Sintaxe

run beforeCreateRecord in h-handle.

Descrição

Realiza override antes da criação de algum registro.

Parâmetros

Descrição

Nenhum

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

Descrição

Realiza override antes de eleminar algum registro.

Parâmetros

Descrição

Nenhum

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

Descrição

Realiza override antes de alterar algum registro.

Parâmetros

Descrição

Nenhum

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 a próxima numeração do documento.

Os valores não podem ser menor que 1900.

Parâmetros

Descrição

pDoc

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

Requisito

Ser executado apenas quando é feita uma cópia de registro.

Sintaxe

run buscaTTMovto in h-handle (input <Rowid>,

                             output <temp-table>).

Descrição        

Realiza uma busca utilizando o rowid da tabela origem afim de recuperar todos os dados da mesma.

Parâmetros

Descrição

PRowid

Rowid da tabela

ttMovto

Temp-Table utilizada para armazenar os dados da tabela buscada.

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

                                        input <character>).

Descrição

Realiza verificações nos processo que possuem determinado Equipamento.

Parâmetros

Descrição

pEmpresa

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

Requisito

Procedure para uso interno.

Sintaxe

RUN atualizaMovimentos IN h-handle (input <date>,

                                    input <character>).

Descrição

Realiza a atualização das Parcelas “Movimentos de Eventos” relacionados ao documento de Processo Administrativo.

Parâmetros

Descrição

pDateFinal

Data de término da Parcela “Movimentos de Eventos”

pHorFinal

Hora de término da Parcela “Movimentos de Eventos”

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 para uso interno.

Sintaxe

    {masterdetail/openqueriesson.i &Parent="Evento"

                                   &Query="Evento"

                                   &PageNumber="2"}

Obs.: Utilizado na abertura de  query 

Descrição

Utilizada para busca de relacionamento de registro Pai/Filho.

Parâmetros

Descrição

pHandle

Handle

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

Sintaxe

run openQueryEvento in h-handle.

Descrição

Abre a query da BO conforme o número de documento passado na procedure setConstraintEvento

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 para uso interno.

Sintaxe

RUN removeMovimentos IN h-handle.

Descrição

Remove todas as Parcelas “Movimentos de Eventos” relacionados ao documento de Processo Administrativo.

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

Descrição

Seta as restrições para abrir a query por faixa do Número do Documento.

Parâmetros

Descrição

pNumDocto

Número do Documento do Processo Administrativo

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.