BOMN288 - BO da tabela mi-calend-recor

Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico:	mnbo/bomn288.p

Objetivo

Incluir, atualizar, consultar e eliminar dados da tabela mi-calend-recor do aplicativo de manutenção industrial.

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN.

A sintaxe para a chamada da API/BO é:

run mnbo/bomn288.p.

A sintaxe para executar a API/BO em modo persistente é:

run mnbo/bomn288.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 API.

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária	Descrição	Entrada/Saída
RowObject	Tabela de comunicação entre interface e banco de dados da tabela mi-calend-recor.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
num-calend-recor	Integer	>>>>,>>9	Número Recorrência	Sim
frequencia	Integer	>>>9	Frequência	Não
num-freq-semanal	Integer	>>>>,>>9	Frequência semanal	Não
log-dom	Logical	Sim/Não	Domingo	Não
log-seg	Logical	Sim/Não	Segunda-feira	Não
log-ter	Logical	Sim/Não	Terça-feira	Não
log-qua	Logical	Sim/Não	Quarta-feira	Não
log-qui	Logical	Sim/Não	Quinta-feira	Não
log-sex	Logical	Sim/Não	Sexta-feira	Não
log-sab	Logical	Sim/Não	Sábado	Não
tp-dia	Integer	>9	Tipo dia	Não
num-dia-mes	Integer	>>>>,>>9	Dia do mês	Não
num-freq-mes	Integer	>>>>,>>9	Frequência mês	Não
idi-freq-sema	Integer	9	Frequência semana	Não
idi-dia-sema	Integer	9	Dia semana	Não
cod-livre-1	Character	X(100)	Livre 1	Não
cod-livre-2	Character	X(500)	Livre 2	Não
cod-livre-3	Character	X(100)	Livre 3	Não
cod-livre-4	Character	X(100)	Livre 4	Não
dat-livre-1	Date	99/99/9999	Livre 1	Não
dat-livre-2	Date	99/99/9999	Livre 2	Não
dat-livre-3	Date	99/99/9999	Livre 3	Não
dat-livre-4	Date	99/99/9999	Livre 4	Não
log-livre-1	Logical	Sim/Não	Livre 1	Não
log-livre-2	Logical	Sim/Não	Livre 2	Não
log-livre-3	Logical	Sim/Não	Livre 3	Não
log-livre-4	Logical	Sim/Não	Livre 4	Não
num-livre-1	Integer	>>>>>>>>9	Livre 1	Não
num-livre-2	Integer	>>>>>>>>9	Livre 2	Não
num-livre-3	Integer	>>>>>>>>9	Livre 3	Não
num-livre-4	Integer	>>>>>>>>9	Livre 4	Não
val-livre-1	Decimal	->>>>>>>>>>>9.99999999	Livre 1	Não
val-livre-2	Decimal	->>>>>>>>>>>9.99999999	Livre 2	Não
val-livre-3	Decimal	->>>>>>>>>>>9.99999999	Livre 3	Não
val-livre-4	Decimal	->>>>>>>>>>>9.99999999	Livre 4	Não

Tabela Temporária	Descrição	Entrada/Saída
RowErrors	Contém os erros ocorridos na BO.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ErrorSequence	Integer	Padrão	Sequê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 <integer>)
Descrição	Posiciona o registro da mi-calend-recor por meio dos códigos do curso e especialidade.
	Parâmetros	Descrição
	pnum-calend-recor	Código do calendário de recorrê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.

getKey

Requisito	Nenhum
Sintaxe	run getKey in h-handle (output <integer>)
Descrição	Retorna os campos da chave primária do registro posicionado.
	Parâmetros	Descrição
	pnum-calend-recor	Código do calendário de recorrê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.

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 sequê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

openQueryMain

Requisito	Nenhum
Sintaxe	run openQueryMain in h-handle
Descrição	Busca conjunto de registros da tabela mi-calend-recor.
	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	Executar alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.
Sintaxe	run validateRecord 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 de erros são especificados na temp-table RowErrors.

Árvore de páginas