Linha Datasul

Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicodibo/bodi00709.p

 

Considerações Gerais

 

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela portal-model-val (Portal Modelo Valor).

 

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A execução na forma persistente é realizada através da chamada de um comando RUN conforme exemplo a seguir.

A sintaxe para executar a BO em modo persistente é:

 

RUN dibo/bodi00709.p PERSISTENT SET h-bodi00709.

 

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 de entrada e saída:

 

tt-portal-model-val

Entrada/Saída

Portal Modelo Valor

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

idi-model

integer 

>>>>>>>9

Modelo

Sim

 

num-seq-campo

integer 

999

Sequencia Campo

Sim

 

num-seq-item  

integer

>,>>9

Sequencia Item

Sim

 

cod-campo

character

x(32)

Código do Campo

Sim

 

cod-valor

character

x(120)

Valor

Não

 

cod-livre-1

character

x(100)

Código Livre 1   

Não

 

cod-livre-2

character

x(500)

Código Livre 2   

Não

 

cod-livre-3

character

x(100)

Código Livre 3   

Não

 

cod-livre-4

character

x(100)

Código Livre 4    

Não

 

dat-livre-1

date

99/99/9999

Data Livre 1   

Não

 

dat-livre-2

date

99/99/9999

Data Livre 2   

Não

 

dat-livre-3

date

99/99/9999

Data Livre 3   

Não

 

dat-livre-4

date

99/99/9999

Data Livre 4   

Não

 

log-livre-1

logical

Sim/Não

Lógico Livre 1    

Não

 

log-livre-2

logical

Sim/Não

Lógico Livre 2   

Não

 

log-livre-3

logical

Sim/Não

Lógico Livre 3   

Não

 

log-livre-4

logical

Sim/Não

Lógico Livre 4   

Não

 

num-livre-1

integer

>>>>>>>>9

Número Livre 1   

Não

 

num-livre-2

integer

>>>>>>>>9

Número Livre 2   

Não

 

num-livre-3

integer

>>>>>>>>9

Número Livre 3   

Não

 

num-livre-4

integer

>>>>>>>>9

Número Livre 4   

Não

 

val-livre-1

decimal

->>>>>>>>>>>9.99999999

Valor Livre 1   

Não

 

val-livre-2

decimal

->>>>>>>>>>>9.99999999

Valor Livre 2   

Não

 

val-livre-3

decimal

->>>>>>>>>>>9.99999999

Valor Livre 3   

Não

 

val-livre-4

decimal

->>>>>>>>>>>9.99999999

Valor Livre 4   

Não

 

r-Rowid

Rowid

 

 

Não

 

 

Método Básico

 

getCharField

Requisito

Nenhum

Sintaxe

RUN getCharField IN handle (INPUT <character>,

                                                OUTPUT <character>).

Descrição

Retorna valor dos campos do tipo caracter

Parâmetros

Descrição

pFieldName

Nome do campo caracter que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo caracter que foi solicitado a BO.

getDateField

Requisito

Nenhum

Sintaxe

RUN getDateField IN handle (INPUT <character>,

                                                OUTPUT <date>).

Descrição

Retorna valor dos campos do tipo data

Parâmetros

Descrição

pFieldName

Nome do campo data que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo data que foi solicitado a BO.

getDecField

Requisito

Nenhum

Sintaxe

RUN getDecField IN handle (INPUT <character>,

                                              OUTPUT <decimal>).

Descrição

Retorna valor dos campos do tipo decimal

Parâmetros

Descrição

pFieldName

Nome do campo decimal que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo decimal que foi solicitado a BO.

getIntField

Requisito

Nenhum

Sintaxe

RUN getIntField IN handle (INPUT <character>,

                                            OUTPUT <integer>).

Descrição

Retorna valor dos campos do tipo inteiro

Parâmetros

Descrição

pFieldName

Nome do campo inteiro que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo inteiro que foi solicitado a BO.

getLogField

Requisito

Nenhum

Sintaxe

RUN getLogField IN handle (INPUT <character>,

                                              OUTPUT <logical>).

Descrição

Retorna valor dos campos do tipo logico

Parâmetros

Descrição

pFieldName

Nome do campo logico que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo logico que foi solicitado a BO.

getRawField

Requisito

Nenhum

Sintaxe

RUN getRawField IN handle (INPUT <character>,

                                                OUTPUT <raw>).

Descrição

Retorna valor dos campos do tipo raw

Parâmetros

Descrição

 

pFieldName

Nome do campo raw que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo raw que foi solicitado a BO.

getRecidField

Requisito

Nenhum

Sintaxe

RUN getRecidField IN handle (INPUT <character>,

                                                 OUTPUT <recid>).

Descrição

Retorna valor dos campos do tipo recid

Parâmetros

Descrição

 

pFieldName

Nome do campo recid que será retornado o valor

 

pFieldValue

Valor contido no campo solicitado

Retorno

A BO irá retornar o valor contido no campo recid que foi solicitado a BO.

getKey

Requisito

Nenhum

Sintaxe

RUN getKey IN handle (OUTPUT <integer>).

Descrição

Retorna a chave do registro posicionado

Parâmetros

Descrição

 

pidi-model

Indica a sequencia de identificação do modelo.

Retorno

A BO irá retornar o valor contido no campo modelo que foi solicitado a BO.

goToKey

Requisito

Nenhum

Sintaxe

RUN goToKey IN h-handle (INPUT <integer>,

                                             INPUT <integer>).

Descrição

Reposiciona registro com base na chave informada

Parâmetros

Descrição

 

pidi-model

Indica a sequencia de identificação do modelo.

 

pnum-seq-campo

Indica a sequencia do valor do modelo.

Retorno

A BO irá reposicionar no registro que foi solicitado a BO.

validateRecord

Requisito

Nenhum

Sintaxe

RUN validateRecord IN h-handle (INPUT <character>).

Descrição

Efetua as validações do registro antes de ser gravado na tabela de campos do portal

Parâmetros

Descrição

 

pType

Indica o o tipo de gravação do registro (Create, Delete e Update).

Retorno

“OK” – Registro gravado corretamente

“NOK” – Registro inválido, Verificar a lista de erros na temp-table RowErrors

 

Método Negócio

 

assignNumId

Requisito

Nenhum

Sintaxe

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

                                                output <character>).

Descrição

Método para retornar a sequencia da próxima chave primaria da tabela

Parâmetros

Descrição

p-i-idi-model

Indica a sequencia da configuração do modelo do cliente

p-c-num-id

Retorna a próxima sequencia da tabela

Retorno

Retorna a última sequencia da tabela

returnFields

Requisito

Nenhum

Sintaxe

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

                                              input-output <character>).

Descrição

Método para retornar o campo correspondente ao label

Parâmetros

Descrição

p-c-num-seq-item

Indica a sequencia do item

p-c-cod-campo

Retorna o campo respectivo ao label informado

Retorno

Retorna o campo de acordo com o label informado

returnFields

Requisito

Nenhum

Sintaxe

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

                                              input-output <character>).

Descrição

Método para retornar o campo correspondente ao label

Parâmetros

Descrição

p-c-num-seq-item

Indica a sequencia do item

p-c-cod-campo

Retorna o campo respectivo ao label informado

Retorno

Retorna o campo de acordo com o label informado

searchFieldsTable

Requisito

Nenhum

Sintaxe

RUN searchFieldsTable IN h-handle (INPUT <character>,

                                                            INPUT <integer>,

                                                            INPUT <integer>,

                                                            OUTPUT <character>).

Descrição

Método para retornar os campo de uma tabela

Parâmetros

Descrição

p-c-num-seq-item

Indica da sequencia do item informado

 

p-cod-repres

Código do representante

 

p-tip-configur

Tipo de configuração

 

p-c-result

Campos da tabela informada

Retorno

Retorna os campos da tabela informada

returnIndex

Requisito

Nenhum

Sintaxe

RUN returnIndex IN h-handle (INPUT <character>,

                                                INPUT <character>,

                                                OUTPUT <integer>).

Descrição

Método para retornar o índice de um campo de uma tabela

Parâmetros

Descrição

p-c-num-seq-item

Indica da sequencia do item informado

 

p-c-cod-campo

Nome do campo para o label informado

 

p-index-campo

Índice do campo para o label informado

Retorno

Retorna o índice da tabela e do campo para o label informado

searchFields

Requisito

Nenhum

Sintaxe

RUN searchFields IN h-handle (INPUT <character>,

                                                   INPUT <integer>,

                                                   INPUT <integer>,

                                                   OUTPUT TABLE ttTable_aux).

Descrição

Método para retornar os campo de uma tabela

Parâmetros

Descrição

p-c-num-seq-item

Indica sequencia do item informado

 

p-cod-repres

Código do representante

 

p-tip-configur

Tipo de configuração

 

ttTable_aux

Temp-table com os campos da tabela informada

Retorno

 Retorna os campos da tabela informada

returnAllFields

Requisito

Nenhum

Sintaxe

RUN returnAllFields IN h-handle (OUTPUT TABLE ttTable).

Descrição

Método para retornar todos os campos de pedido de venda

Parâmetros

Descrição

ttTable

Temp-table com todos os campos de pedido de venda

Retorno

Retorna todos os campos presentes na tabela pedido de venda

verifyRecordSelected

Requisito

Nenhum

Sintaxe

RUN verifyRecordSelected IN h-handle (INPUT <character>,

                                                               OUTPUT <logical>,

                                                               OUTPUT <logical>,

                                                               OUTPUT <character>,

                                                               OUTPUT <character>,

                                                               OUTPUT <character>, 

                                                               OUTPUT <logical>,    

                                                               OUTPUT <character>).

Descrição

Método para verificar campos com zoom, lógico e combo.

Parâmetros

Descrição

p-c-cod-campo

Indicativo do campo

 

p-l-logico

Verifica se o campo é lógico

 

p-l-zoom

Verifica se o campo é um zoom

 

p-c-xml-name

Veritica o nome do XML do zoom

 

p-c-field-code

Verifica o nome do field-code do zoom

 

p-c-field-label

Verifica o nome do field-label do zoom

 

p-l-combo

Verifica se o campo é um combo

 

p-c-list-items

Verifica a lista de opções do zoom

Retorno

Retorna a lista de definições do campo a ser verificado

OpenQuery / SetConstraint / LinkTo

 

openQueryDefault

Requisito

Nenhum

Sintaxe

run openQueryStatic in h-handle (input "Default":U).

Descrição

Faz a abertura da tabela principal.

Parâmetros

Descrição

 

 

Retorno