Linha Datasul

Árvore de páginas

BO Layouts Usuário / Documento

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico:

inbo/boin01100.p

Include com Parâmetros:inbo/boin01100.i e inbo/boin01100.i1
Bancomgind
Tabelamla-layout-usuar-doc


Objetivo

Esta BO tem como objetivo a manipulação dos dados referentes a tabela mla-layout-usuar-doc (Layouts de Usuário / Documento).


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/boin01100.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
Layout do usuário/documento
AtributoTipoFormatoDescriçãoObrigatório
cod-usuarCHARACTERx(12)UsuárioSim
cdn-doctoINTEGER  >>9DocumentoSim
idi-interfacINTEGER  >9InterfaceSim
cod-id-campoCHARACTER  X(80)ID do Campo

Sim

idi-componINTEGER  >9Tipo ComponenteSim
nom-rotu-campoCHARACTER  X(40)Rótulo do CampoNão
des-campoCHARACTER  X(200)Descrição do CampoSim
log-visivelLOGICALSim/NãoVisívelSim
cdn-tamINTEGER>>9TamanhoSim
cdn-ordINTEGER>>>9OrdemSim
cod-entid-paiCHARACTERX(80)Código Entidade PaiNão
cod-livre-1CHARACTERx(500)Livre 1Não
cod-livre-2CHARACTERx(500)Livre 2Não
log-livre-1LOGICALSim/NãoLivre 1Não
log-livre-2LOGICALSim/NãoLivre 2Não
num-livre-1INTEGER>>>>>>>>9Livre 1Não
num-livre-2INTEGER>>>>>>>>9Livre 2Não
val-livre-1DECIMAL->>>>>>>>>>>9.99999999Livre 1Não
val-livre-2DECIMAL->>>>>>>>>>>9.99999999Livre 2Não
dat-livre-1DATE99/99/9999Livre 1Não
dat-livre-2DATE99/99/9999Livre 2Não



tt-mla-layout-usuar-doc-origem e tt-mla-layout-usuar-doc-dest

Layout do usuário/documento origem e destino
AtributoTipoFormatoDescriçãoObrigatório
cod-usuarCHARACTERx(12)UsuárioSim
cdn-doctoINTEGER  >>9DocumentoSim
idi-interfacINTEGER  >9InterfaceSim
cod-id-campoCHARACTER  X(80)ID do Campo

Sim

idi-componINTEGER  >9Tipo ComponenteSim
nom-rotu-campoCHARACTER  X(40)Rótulo do CampoNão
des-campoCHARACTER  X(200)Descrição do CampoSim
log-visivelLOGICALSim/NãoVisívelSim
cdn-tamINTEGER>>9TamanhoSim
cdn-ordINTEGER>>>9OrdemSim
cod-entid-paiCHARACTERX(80)Código Entidade PaiNão
cod-livre-1CHARACTERx(500)Livre 1Não
cod-livre-2CHARACTERx(500)Livre 2Não
log-livre-1LOGICALSim/NãoLivre 1Não
log-livre-2LOGICALSim/NãoLivre 2Não
num-livre-1INTEGER>>>>>>>>9Livre 1Não
num-livre-2INTEGER>>>>>>>>9Livre 2Não
val-livre-1DECIMAL->>>>>>>>>>>9.99999999Livre 1Não
val-livre-2DECIMAL->>>>>>>>>>>9.99999999Livre 2Não
dat-livre-1DATE99/99/9999Livre 1Não
dat-livre-2DATE99/99/9999Livre 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 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.

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

                                       OUTPUT <integer>,

                                       OUTPUT <character>).

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
pcdn-doctoCódigo do Documento
pcod-id-campoID do campo

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

                                             INPUT <integer>,

                                             INPUT <character>).

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
pcdn-doctoCódigo do Documento
pcod-id-campoID do campo

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


userHasAnyLayout

Requisito

Não há.

Sintaxe

RUN userHasAnyLayout in h-handle (INPUT <pUserCode>,

                                                            OUTPUT <pHasAny> ).

Descrição

Retorna um valor lógico informando se usuário possui layouts

Parâmetros

Tipo

Descrição

pUserCode

CHARACTER

Código do usuário

pHasAnyLOGICALIndica se há layouts para o usuário

Retorno

Indicação se o usuário possui ou não layouts.



pi-copia-substituicao-layouts

Requisito

Usuário com layouts cadastrados no MLA.

Sintaxe

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

                                                                             INPUT <pcDestino>,

                                                                             INPUT <piOpcao>,

                                                                             INPUT <plSimulaAlteracao>,

                                                                             OUTPUT  TABLE <tt-mla-layout-usuar-doc-origem>,

                                                                             OUTPUT  TABLE <tt-mla-layout-usuar-doc-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-layout-usuar-doc-origemTEMP-TABLEContém os dados dos registros (Layouts) do usuário origem
tt-mla-layout-usuar-doc-destTEMP-TABLEContém os dados dos registros (Layouts) do usuário destino

Retorno

Layouts do usuário origem e destino.



piEliminaCamposLayout

Requisito

Não há.

Sintaxe

RUN piEliminaCamposLayout in h-handle (INPUT <cUser>,

                                                                     INPUT <iInterface>,

                                                                     INTPUT <iDocument> ).

Descrição

Elimina os campos de layout de um Usuário, Interface e Documento

Parâmetros

Tipo

Descrição

cUser

CHARACTER

Código do usuário

iInterfaceINTEGERInterface
iDocumentINTEGERDocumento

Retorno

Não há.


OpenQuery / SetConstraint / LinkTo

Não há