Histórico da Página

...

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	frbo/bofr051

Objetivo

Validação, Manutenção e acesso rápido a tabela “mpn-pneu”.

Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mpn-pneu”.

...

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da BO.

Tabelas Temporárias

Nos atributos das tabelas temporárias:

Tabela Temporária	Descrição	Entrada/Saída
RowObject	Tabela de comunicação entre Interface e banco de dados da tabela “mpn-pneu”.	Entrada/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

Métodos

Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

goToKey

Requisito	Nenhum
Sintaxe	run goToKey in h-handle (input <character>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pcod-pneu	Código do Pneu
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.

getKey

Requisito	Nenhum
Sintaxe	run getKey in h-handle (output <character>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pcod-pneu	Código do Pneu
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.

getCharField

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.

getDateField

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.

getDecField

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.

getIntField

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.

getLogField

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.

getRawField

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.

getRecidField

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.

getRowid

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.

...

OpenQuery / SetConstraint / LinkTo

linkToMab-eqpto

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela mpn-pneu.
Sintaxe	run linkToMab-eqpto in h-handle (input <hanlde>).
Descrição	Faz o JOIN entre as tabelas “mpn-pneu” e “mab-eqpto”. Recebe como parâmetro o handle da BO da tabela mpn-pneu, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintMab-eqpto”.
	Parâmetros	Descrição
	pHandle	Handle da BO “Mab-eqpto”.
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.

setConstraintCodModel

Requisito	Nenhum
Sintaxe	run setConstraintCodModel in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query por filtro do programa de atualização de pneus.
	Parâmetros	Descrição
	pCodModelIni	Código Modelo Inicial
	pCodModelFim	Código Modelo 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.

setConstraintCodPneu

Requisito	Nenhum
Sintaxe	run setConstraintCodPneu in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query por filtro do programa de atualização de pneus.
	Parâmetros	Descrição
	pCodPneuIni	Código Pneu Inicial
	pCodPneuFim	Código Pneu 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.

setConstraintDesativacao

Requisito	Nenhum
Sintaxe	run setConstraintDesativacao in h-handle (input <character>, input <character>).
Descrição	Seta as restrições para abrir a query por filtro do programa de atualização de pneus.
	Parâmetros	Descrição
	pPneuIni	Código Pneu Inicial
	pPneuFim	Código Pneu 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.

setConstraintSomenteEstoque

Requisito	Nenhum
Sintaxe	run setConstraintSomenteEstoquein h-handle (input <logical>).
Descrição	Seta as restrições para abrir a query para somente apresentar pneus que estejam em estoque.
	Parâmetros	Descrição
	pEstoque	Verificar somente pneus em estoque
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.

setConstraintFiltro

Requisito	Nenhum
Sintaxe	run setConstraintFiltro in h-handle (input <character>, input <character>, input <character>, input <character>, input <character>, input <character>, 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 datas de movimentos de pneus.
	Parâmetros	Descrição
	pCodModelIni	Modelo Inicial
	pCodModelFim	Modelo Final
	pMedidaIni	Medida Inicial
	pMedidaFim	Medida Final
	pEstabIni	Estabelecimento Inicial
	pEstabFim	Estabelecimento Final
	psituIni	Situação Inicial
	pSituFim	Situação Final
	pPosicIni	Posição Inicial
	pPosicFim	Posição Final
	pDataIni	Data Inicial
	pDataFim	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). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

setConstraintMaq-eqpto

Requisito	Nenhum
Sintaxe	run setConstraintMab-eqpto in h-handle (input <integer>, input <character>).
Descrição	Seta as restrições para abrir a query por faixa de número dos movimentos de pneus.
	Parâmetros	Descrição
	pEpCodigo	Código Empresa
	pCodEqpto	Código 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.

openQueryCodModel

Requisito	A setConstraintCodModel ter sido executada anteriormente.
Sintaxe	run openQueryCodModel in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintCodModel.
	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.

openQueryCodModelFiltro

Requisito	A setConstraintFiltro ter sido executada anteriormente.
Sintaxe	run openQueryCodModelFiltro in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintFiltro.
	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.

openQueryCodPneu

Requisito	A setConstraintCodPneu ter sido executada anteriormente.
Sintaxe	run openQueryCodPneu in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintCodPneu.
	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.

openQueryCodPneuFiltro

Requisito	A setConstraintFiltro e a setConstraintCodPneu tere sido executadas anteriormente.
Sintaxe	run openQueryCodPneuFiltro in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintFiltro.
	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.

openQueryDesativacao

Requisito	A setConstraintDesativacao ter sido executada anteriormente.
Sintaxe	run openQueryDesativacao in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintDesativacao.
	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.

openQueryMaq-eqpto

Requisito	A setConstraintMab-eqpto ter sido executada anteriormente.
Sintaxe	run openQueryMab-eqpto in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintMab-eqpto.
	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.

openQueryModelFiltro

Requisito	A setConstraintFiltro ter sido executada anteriormente.
Sintaxe	run openQueryModelFiltro in h-handle.
Descrição	Abre a query da BO conforme o filtro passado na procedure setConstraintFiltro
	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.

...

openQueryMain

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.

Método Negócio

validateRecord

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.

afterCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run afterCreateRecord in this-procedure.
Descrição	Atualiza campos internos que não aparecem no cadastro do programa pai (mpn-pneu) e são atualizados na movimentação dos pneus.
	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....

afterUpdateRecord

Requisito	Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.
Sintaxe	run afterUpdateRecord in this-procedure.
Descrição	Atualiza campos internos que não aparecem no cadastro do programa pai (mpn-pneu) e são atualizados na movimentação dos pneus.
	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....

atualizaRegistros

Requisito	Nenhum
Sintaxe	run atualizaRegistros in h-handle (input <character>).
Descrição	Atualiza campos internos que não aparecem no cadastro do programa pai (mpn-pneu) e são atualizados na movimentação dos pneus.
	Parâmetros	Descrição
	pCodPneu	Código do Pneu
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....

buscaFilhos

Requisito	Nenhum
Sintaxe	run buscaFilhos in h-handle (input <character>, input-output <logical>).
Descrição	Verifica se há registro de histórico de vida para o pneu em questão.
	Parâmetros	Descrição
	pCodPneu	Código do Pneu
	pControle	Controle de filhos
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....

...

copiaFilhos

Requisito	Nenhum
Sintaxe	run copiaFilhos in h-handle (input <character>, input <vharacter>).
Descrição	Copia os registro de histórico de vida para o pneu passado como parâmetro.
	Parâmetros	Descrição
	cCodpneuAnt	Código do Pneu a ser copiado
	cCodpneuAtu	Código do Pneu para copiar
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....

...

DesativaPneus

Requisito	Nenhum
Sintaxe	run DesativaPneus in h-handle (input <character>, input <character>, input <character>, input <character>, output <date>).
Descrição	Altera status do pneu para Desativado ou se o usuário desfaz a ação retorna status para ativo.
	Parâmetros	Descrição
	pPneu	Código do Pneu
	pDslObs	Observação
	pCausaPadr	Causa Desativação
	pCodUsuar	Código do Usuário
	pDataAtual	Data Atualização da Situaçã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....

...

Árvore de páginas