Linha Datasul

Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicodibo/bodi00714.p

 

Considerações Gerais

 

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela portal-campos (Campos do Portal).

 

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/bodi00714.p PERSISTENT SET h-bodi00714.

 

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

Entrada/Saída

Campos do Portal

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

         idi-seq

Integer

>>>>>>>9

Sequencia

Sim

 

cod-tabela

character

x(32)

Tabela

Sim

 

num-seq

integer

>>>>9

Número Sequencia

Sim

 

cod-campo

character

x(32)

Código do Campo

Sim

 

log-visivel

Logical

Sim/Não

Vísivel

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

 

 

 

 

ttTable

Entrada/Saída

Temp-table dos campos e tabelas

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

         i-index

Integer

 

 

 

 

c-entidade

character

 

 

 

 

c-table

character

 

 

 

 

c-field

character

 

 

 

 

c-label

character

 

 

 

 

ttTable_aux

Entrada/Saída

Temp-table dos campos e tabelas auxiliar

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

         i-index

Integer

 

 

 

 

c-entidade

character

 

 

 

 

c-table

character

 

 

 

 

c-field

character

 

 

 

 

c-label

character

 

 

 

 

 

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

                                      OUTPUT <integer>).

Descrição

Retorna a chave do registro posicionado

Parâmetros

Descrição

 

pidi-seq

Indica a sequencia de identificação da configuração do cliente.

 

pnum-livre-2

Indica a sequencia do campo.

Retorno

A BO irá retornar o valor contido nos campos sequencia e número livre 2 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-seq

Indica a sequencia de identificação da configuração do cliente.

 

pnum-livre-2

Indica a sequencia do campo.

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

 

returnRecords

Requisito

Nenhum

Sintaxe

RUN returnRecords IN h-handle (INPUT-OUTPUT <character>,

                                                     INPUT-OUTPUT <character>,

                                                     INPUT <integer>,

                                                     INPUT <integer>).

Descrição

Método para retornar o nome da tabela e campo para o label informado

Parâmetros

Descrição

p-c-cod-tabela

Nome da tabela para o label informado

 

p-c-cod-campo

Nome do campo para o label informado

 

p-cdn-repres

Código do Representante

 

p-tip-configur

Tipo de Configuração

Retorno

Retorna  os registros para o label informado

assignNumId

Requisito

Nenhum

Sintaxe

run assignNumId in h-handle (output <character>).

Descrição

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

Parâmetros

Descrição

p-c-num-id

Retorna a próxima sequencia da tabela

Retorno

Retorna a última sequencia da tabela

returnIndex

Requisito

Nenhum

Sintaxe

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

                                                INPUT <character>,

                                                INPUT <integer>,

                                                INPUT <integer>,

                                                OUTPUT <integer>,

                                                OUTPUT <integer>).

Descrição

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

Parâmetros

Descrição

p-c-cod-tabela

Nome da tabela para o label informado

 

p-c-cod-campo

Nome do campo para o label informado

 

p-cdn-repres

Código do representante

 

p-tip-configur

Tipo de configuração

 

p-index-tabela

Índice da tabela 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

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

Indicador da tabela informada

 

p-cdn-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

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

Indicador da tabela informada

 

p-cdn-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

getTtTable

Requisito

Nenhum

Sintaxe

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

Descrição

Método para retornar a temp-table ttTable

Parâmetros

Descrição

ttTable

Temp-table com os campos da tabela

Retorno

Retorna a temp-table com os campos da tabela

setTtTable

Requisito

Nenhum

Sintaxe

RUN setTtTable IN h-handle (INPUT TABLE ttTable).

Descrição

Método para setar a temp-table ttTable

Parâmetros

Descrição

ttTable

Temp-table com os campos da tabela

Retorno

Nenhum

 

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