Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 frbo/bofr047

...


Objetivo

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

...

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

 

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:

...

setConstraintCodLayout

 

Requisito

Nenhum         

Sintaxe

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

                                        input <character>).

Descrição

Seta as restrições para abertura da query por faixa de Código do Layout.

 

Parâmetros

Descrição

 

pCodLayoutIni

Código do Layout Inicial

 

pCodLayoutFim

Código do Layout 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.

   

setConstraintDescLayout

Requisito

Nenhum         

Sintaxe

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

                                         input <character>).

Descrição

Seta as restrições para abertura da query por faixa de Descrição Layout.

 

Parâmetros

Descrição

 

pDescLayoutIni

Descrição Layout Inicial

 

pDescLayoutFim

Descrição Layout 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.

    

openQueryCodLayout

Requisito

A setConstraintCodLayout ter sido executada anteriormente.

Sintaxe

run openQueryCodLayout in h-handle.

Descrição

Abre a query da BO conforme a faixa de Código do Layout passada na procedure setConstraintCodLayout.

 

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

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.

copiaFilhos

 

Requisito

Nenhum.

Sintaxe

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

                             input <character>).

Descrição

Faz copia da tabela filho.

 

Parâmetros

Descrição

 

cCodLayoutAnt

Código do Layout Anterior

cCodLayoutAtu

Código do Layout Atual

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.