Linha Datasul

Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físicodibo/bodi00706.p

 

Considerações Gerais

 

Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela portal-configur-clien (Portal Configuração Cliente).

 

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

 

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

Entrada/Saída

Portal Configuração Cliente

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

idi-seq

integer 

>>>>>>>9

Modelo

Sim

 

cdn-clien

integer 

>>>>>>>>9

Código Cliente

Não

 

cdn-grp-clien  

integer

>9

Código Grupo Cliente

Não

 

idi-clien-repres

integer

9

Cliente Representante

Não

 

log-cond-clien-repres

logical

Sim/Não

Cond. Pag para Rep

Não

 

log-item-clien-repres

logical

Sim/Não

Item Cliente Rep

Não

 

cdn-repres

integer

>>>>9

Código Representante

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

 

ttUsuarios

Entrada/Saída

Temp-table com usuários

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

         id-usuario

Integer

 

 

 

 

 

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

Indica a sequencia de identificação do registro.

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

Descrição

Reposiciona registro com base na chave informada

Parâmetros

Descrição

 

pidi-seq

Indica a sequencia de identificação do registro

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 configuração 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

 

assignNumId

Requisito

Nenhum

Sintaxe

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

Descrição

Método para retornar a sequencia da próxima chave primária da tabela

Parâmetros

Descrição

p-c-num-id

Retorna a próxima sequencia para a tabela.

Retorno

Retorna a próxima sequencia da tabela.

unlockUser

Requisito

Nenhum

Sintaxe

RUN unlockUser IN h-handle (INPUT <integer> ).

Descrição

Método para desbloquear os usuários do cliente.

Parâmetros

Descrição

p-c-cdn-clien

Identifica o código do cliente

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