Linha Datasul

Árvore de páginas

BO Configuração Visual Usuário

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico:

inbo/boin01101.p

Include com Parâmetros:inbo/boin01101.i e inbo/boin01101.i1
Bancomgind
Tabelamla-configur-visual-usuar


Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela mla-configur-visual-usuar (Configuração Visual Usuário).


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 inbo/boin01101.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 BO.  

Tabelas Temporárias

RowObject
Configurações visuais do usuário
AtributoTipoFormatoDescriçãoObrigatório
cod-usuarCHARACTERx(12)UsuárioSim
idi-interfacINTEGER  >9InterfaceSim
idi-ordenacaoINTEGER>9Ordenação PadrãoSim
num-registro-paginacINTEGER>>>9Número Registro por PáginaNão
log-mostra-todas-empresLOGICALSim/NãoApresenta Todas EmpresasNão
idi-visualiz-inicialINTEGER>9Visualização InicialNão
cdn-temp-desfINTEGER>9Tempo DesfazerNão
idi-acao-swip-direINTEGER9Ação Swipe DireitaNão
idi-acao-swip-esqINTEGER9Ação Swipe EsquerdaNão
log-aprova-sem-motivLOGICALSim/NãoAprova sem Informar MotivoNão
cod-livre-1CHARACTERx(500)Livre 1Não
cod-livre-2CHARACTERx(500)Livre 2Não
num-livre-1INTEGER>>>>>>>>9Livre 1Não
num-livre-2INTEGER>>>>>>>>9Livre 2Não
log-livre-1LOGICALSim/NãoLivre 1Não
log-livre-2LOGICALSim/NãoLivre 2Não
dat-livre-1DATE99/99/9999Livre 1Não
dat-livre-2DATE99/99/9999Livre 2Não
val-livre-1DECIMAL->>>>>>>>>>>9.99999999Livre 1Não
val-livre-2DECIMAL->>>>>>>>>>>9.99999999Livre 2Não



tt-mla-conf-visual-usuar-origem e tt-mla-conf-visual-usuar-dest
Configurações visuais do usuário origem e destino
AtributoTipoFormatoDescriçãoObrigatório
cod-usuarCHARACTERx(12)UsuárioSim
idi-interfacINTEGER  >9InterfaceSim
idi-ordenacaoINTEGER>9Ordenação PadrãoSim
num-registro-paginacINTEGER>>>9Número Registro por PáginaNão
log-mostra-todas-empresLOGICALSim/NãoApresenta Todas EmpresasNão
idi-visualiz-inicialINTEGER>9Visualização InicialNão
cdn-temp-desfINTEGER>9Tempo DesfazerNão
idi-acao-swip-direINTEGER9Ação Swipe DireitaNão
idi-acao-swip-esqINTEGER9Ação Swipe EsquerdaNão
log-aprova-sem-motivLOGICALSim/NãoAprova sem Informar MotivoNão
cod-livre-1CHARACTERx(500)Livre 1Não
cod-livre-2CHARACTERx(500)Livre 2Não
num-livre-1INTEGER>>>>>>>>9Livre 1Não
num-livre-2INTEGER>>>>>>>>9Livre 2Não
log-livre-1LOGICALSim/NãoLivre 1Não
log-livre-2LOGICALSim/NãoLivre 2Não
dat-livre-1DATE99/99/9999Livre 1Não
dat-livre-2DATE99/99/9999Livre 2Não
val-livre-1DECIMAL->>>>>>>>>>>9.99999999Livre 1Não
val-livre-2DECIMAL->>>>>>>>>>>9.99999999Livre 2Não
situacaoCHARACTERX(20)SituaçãoNão
id-sitINTEGER>>9

ID da Situação

1 - Mantido

2 - Novo

3 - Alterado

4 - Eliminado

5 - Origem

6 - Destino

7 - Erro

Não
r-rowidROWID
Rowid do registroNão
errosCHARACTERX(2000)Erros ocorridosNão


Metodo Básico


Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

getCharField

Requisito

Query posicionada no registro.

Sintaxe

RUN getCharField IN handle (INPUT <character>,

                                                OUTPUT <character>).

Descrição



 

Retorna valor dos campos do tipo caractere

Parâmetros

Descrição

pFieldName

Nome do campo caractere que será retornado o valor

pFieldValue

Valor contido no campo solicitado

Retorno

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

getDateField

Requisito

Query posicionada no registro.

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.

getDecField

Requisito

Query posicionada no registro.

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.

getIntField

Requisito

Query posicionada no registro.

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.

getLogField

Requisito

Query posicionada no registro.

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.

getRawField

Requisito

Query posicionada no registro.

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.

getRecidField

Requisito

Query posicionada no registro.

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.

getKey

Requisito

Query posicionada no registro.

Sintaxe

RUN getKey IN handle (OUTPUT <character>,

                                       OUTPUT <integer>).

Descrição


 

Retorna valores dos campos do índice primário e único da tabela.

Parâmetros

Descrição

pcod-usuar

Código do usuário

pidi-interfacInterface

Retorno

A BO irá retornar o valor contido nos campos do índice primário e único da tabela.

goToKey

Requisito

Query estar aberta.

Sintaxe

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

                                             INPUT <integer>).

Descrição


 

Reposiciona registro com base no índice primário e único da tabela.

Parâmetros

Descrição

pcod-usuar

Código do usuário

pidi-interfacInterface

Retorno

A BO irá reposicionar no registro que foi solicitado.



validateRecord

Requisito

Query posicionada no registro.

Sintaxe

Run validateRecord in handle (INPUT pType).

Descrição

Validações pertinentes ao DBO.

Parâmetros

Descrição

pType

Recebe o tipo de validação.

create: Indica a criação de um registro

update: Indica a atualização de um registro

delete: Indica a eliminação de um registro

Retorno



Método Negócio


getDefaults

Requisito

Não há.

Sintaxe

RUN getDefaults in h-handle (INPUT <pc-cod-usuar>,

                                                 INPUT <pi-idi-interfac>,

                                                 OUTPUT TABLE RowObject).

Descrição

Retorna a temp-table RowObject com informações padrões de criação de um
novo registro

Parâmetros

Tipo

Descrição

pc-cod-usuar

CHARACTER

Código do usuário

pi-idi-interfacINTEGERInterface
RowObjectTEMP-TABLERegistro contendo os valores padrões de criação de um novo registro.

Retorno

Valores padrões para criação de novo registro.



pi-copia-substituicao-config-visual

Requisito

Configurações visuais cadastradas para usuário no MLA.

Sintaxe

RUN pi-copia-substituicao-config-visual in h-handle (INPUT <pcOrigem>,

                                                                                      INPUT <pcDestino>,

                                                                                      INPUT <piOpcao>,

                                                                                      INPUT <plSimulaAlteracao>,

                                                                                      OUTPUT  TABLE <tt-mla-conf-visual-usuar-origem>,

                                                                                      OUTPUT  TABLE <tt-mla-conf-visual-usuar-dest>).

Descrição

Realiza a cópia/substituição de layouts para um usuário.

Parâmetros

Tipo

Descrição

pcOrigem

CHARACTER

Código do usuário origem

pcDestinoCHARACTERCódigo do usuário destino
piOpcaoINTEGER

Opção de cópia/substituição: 

1 - Somente inexistentes

2 - Substituir existentes e adicionar inexistentes

3 - Substituir tudo

tt-mla-conf-visual-usuar-origemTEMP-TABLEContém os dados dos registros (Configurações Visuais) do usuário origem
tt-mla-conf-visual-usuar-destTEMP-TABLEContém os dados dos registros (Configurações Visuais) do usuário destino

Retorno

Configurações visuais do usuário origem e destino.


OpenQuery / SetConstraint / LinkTo

Não há