Histórico da Página

...

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

Objetivo

Validação, Manutenção e acesso rápido a tabela “mnd-movto-process”.

Funcionamento

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

...

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:

...

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

getKey

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.

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.

OpenQuery / SetConstraint / LinkTo

setConstraintData

Requisito	Nenhum
Sintaxe	run setConstraintData in h-handle (input <date>, input <date> input <date>, input <date>, input <logical>, input <logical> input <logical>, input <logical>).
Descrição	Seta as restrições para abrir a query por faixa de datas.
	Parâmetros	Descrição
	pDtIncialIni	Data Inicial
	pDtIncialFim	Data Inicial Final
	pDtFinalIni	Data Final Inicial
	pDtFinalFim	Data 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.

setConstraintDocto

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.

setConstraintEquipamento

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.

setConstraintProcesso

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.

openQueryData

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.

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.

openQueryDocto

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.

openQueryEquipamento

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.

openQueryProcess

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.

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

beforeCreateRecord

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

beforeDeleteRecord

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

beforeUpdateRecord

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

atualizaSituacaoEquipamento

Requisito	Nenhum
Sintaxe	run atualizaSituacaoEquipamento in this-procedure.
Descrição	Atualiza situação dos equipamentos nos parâmetros de documentação.
		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....

buscaDocumento

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

buscaTTMovto

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

verificaProcessosEqpto

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

atualizaMovimentos

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.

linkToEvento

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

openQueryEvento

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.

removeMovimentos

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.

setConstraintEvento

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.

Árvore de páginas