Histórico da Página

Documento de BO

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

Objetivo

Validação, Manutenção e acesso rápido a tabela “mmv-tar-plano-epi”.

...

A sintaxe para a chamada BO é:

run frbo\bofr038.p.

A execução na forma persistente ...

...

run frbo\bofr038.p persistent set h-handle.

...

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 “mmv-tar-plano-epi”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cod-model	Char	x(8)	Código do Modelo	Sim


cod-plano	Char	x(8)	Plano Manutenção	Sim


num-seq	Integer	>>>,>>>	Sequência do plano de manutenção	Sim


cd-epi	Char	x(08)	Equipamento de Proteção	Sim


qtd-epi	Dec	->>>,>>9.99	Quantidade de E.P.I	Não


cod-livre-1	Char	x(100)	Character Livre	Não


cod-livre-2	Char	x(100)	Character Livre	Não


log-livre-1	Log	Sim/Não	Logical Livre	Não


log-livre-2	Log	Sim/Não	Logical Livre	Não


num-livre-1	Integer	->>>>>>>>9	Inteiro Livre	Não


num-livre-2	Integer	->>>>>>>>9	Inteiro Livre	Não


val-livre-1	Dec	->>>>>>>>>>>9.9999	Decimal Livre	Não


val-livre-2	Dec	->>>>>>>>>>>9.9999	Decimal Livre	Não


dat-livre-1	Date	99/99/9999	Data Livre	Não


dat-livre-2	Date	99/99/9999	Data Livre	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

Métodos

Quando a API/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>, input <character>, input <integer>, input <character>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pcod-model	recebe valor do campo cod-model
	pcod-plano	recebe valor do campo cod-plano
	pnum-seq	recebe valor do campo num-seq
	pcd-epi	recebe valor do campo cd-epi
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>, output <character>, output <integer>, output <character>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pcod-model	recebe valor do campo cod-model
	pcod-plano	recebe valor do campo cod-plano
	pnum-seq	recebe valor do campo num-seq
	pcd-epi	recebe valor do campo cd-epi
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

linkTommv-tar-plano

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

setConstraintmmv-tar-plano

Requisito	Nenhum
Sintaxe	run setConstraintmmv-tar-plano in h-handle (input <character>, input <character>, input <integer>).
Descrição	Seta as restrições para abrir a query por código modelo, plano manutenção e número da sequência.
	Parâmetros	Descrição
	pcod-model	Código Modelo
	pcod-plano	Código Plano Manutenção
	pnum-seq	Número Sequência
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.

openQuerymmv-tar-plano

Requisito	A setConstraintmmv-tar-plano ter sido executada anteriormente.
Sintaxe	run openQuerymmav-tar-plano in h-handle.
Descrição	Abre a query da BO conforme o código do modelo, plano de manutenção e número da sequência passada na procedure setConstraintmmv-tar-plano.
	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.

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 53

Chave