Histórico da Página

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico:	hbbo/boArqDocto.p
Include com Parâmetros:	hbbo/boArqDocto.i
Banco	mguni
Tabela	arquivo_docto

Objetivo

Esta BO tem como objetivo a manipulação dos dados dos documentos referenciados na tabela arquivo_docto (Informações dos Arquivos dos Processos).

...

A sintaxe para executar a BO em modo persistente é:

RUN hbbo/boArqDocto.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

Informações dos Arquivos
Atributo	Tipo	Formato	Descrição	Obrigatório

cod-usuarCHARACTERx(12)Usuário

num_id_docto	INTEGER	999999999	Número sequencial de identificação do documento	Sim
cdn

-docto

_tipo_proces

INTEGER

>>9

Documento

Tipo do processo ao qual o documento está vinculado

Sim

idi-interfacINTEGER >9Interface

cod_chave_proces	CHARACTER	X(40)	Código da chave do processo	Sim
cod

-id-campo

_usuar_docto

CHARACTER

X(

80

12)

ID

Código do usuário do

Campo

documento

Sim

idi-componINTEGER >9Tipo Componente

dtm_criac_docto	DATETIME	99/99/9999 HH:MM:SS.SSS	Data e hora da criação do documento	Sim
nom

-rotu-campo

_arq_docto

CHARACTER

X(

40

100)

Rótulo

Nome do

Campo

arquivo

Nãodes-campo

Sim
nom_dir_docto	CHARACTER	X(

200

250)

Descrição do Campocod-entid-pai

Diretório onde está armazenado o documento

Sim

log-visivelLOGICALSim/NãoVisívelSimcdn-tamINTEGER>>9TamanhoSimcdn-ordINTEGER>>>9OrdemSim

ind_tam_docto

CHARACTER

X(

80

10)

Código Entidade Pai

Tamanho do arquivo

Não

cod-livre-1

des_docto

CHARACTER

x

X(

500

200)

Livre 1

Descrição do Documento

Não

cod-livre-2CHARACTERx(500)Livre 2Nãolog-livre-1LOGICALSim/NãoLivre 1Nãolog-livre-2LOGICALSim/NãoLivre 2Nãonum-livre-1INTEGER>>>>>>>>9Livre 1Nãonum-livre-2INTEGER>>>>>>>>9Livre 2Nãoval-livre-1DECIMAL->>>>>>>>>>>9.99999999Livre 1Nãoval-livre-2DECIMAL->>>>>>>>>>>9.99999999Livre 2Nãodat-livre-1DATE99/99/9999Livre 1Nãodat-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

ttArquivoDocto
Informações dos Arquivos
Atributo	Tipo	Formato	Descrição	Obrigatório

cod-usuarCHARACTERx(12)Usuário

num_id_docto	INTEGER	999999999	Número sequencial de identificação do documento	Sim
cdn

-docto

_tipo_proces

INTEGER

>>9

Documento

Tipo do processo ao qual o documento está vinculado

Sim

idi-interfacINTEGER >9Interface

cod_chave_proces	CHARACTER	X(40)	Código da chave do processo	Sim
cod

-id-campo

_usuar_docto

CHARACTER

X(

80

12)

ID

Código do usuário do

Campo

documento

Sim

idi-componINTEGER >9Tipo Componente

dtm_criac_docto	DATETIME	99/99/9999 HH:MM:SS.SSS	Data e hora da criação do documento	Sim
nom

-rotu-campo

_arq_docto

CHARACTER

X(

40

100)

Rótulo

Nome do

Campo

arquivo

Nãodes-campo

Sim
nom_dir_docto	CHARACTER	X(

200

250)

Descrição do Campocod-entid-pai

Diretório onde está armazenado o documento

Sim

log-visivelLOGICALSim/NãoVisívelSimcdn-tamINTEGER>>9TamanhoSimcdn-ordINTEGER>>>9OrdemSim

ind_tam_docto

CHARACTER

X(

80

10)

Código Entidade PaiNãocod-livre-1CHARACTERx(500)Livre 1Nãocod-livre-2CHARACTERx(500)Livre 2Nãolog-livre-1LOGICALSim/NãoLivre 1Nãolog-livre-2LOGICALSim/NãoLivre 2Nãonum-livre-1INTEGER>>>>>>>>9Livre 1Nãonum-livre-2INTEGER>>>>>>>>9Livre 2Nãoval-livre-1DECIMAL->>>>>>>>>>>9.99999999Livre 1Nãoval-livre-2DECIMAL->>>>>>>>>>>9.99999999Livre 2Nãodat-livre-1DATE99/99/9999Livre 1Nãodat-livre-2DATE99/99/9999Livre 2NãosituacaoCHARACTERX(20)SituaçãoNãoid-sitINTEGER>>9

ID da Situação

1 - Mantido

2 - Novo

3 - Alterado

4 - Eliminado

5 - Origem

6 - Destino

7 - Erro

Tamanho do arquivo	Não
des_docto	CHARACTER	X(200)	Descrição do Documento	Não
r-rowid	ROWID		Rowid do registro

NãoerrosCHARACTERX(2000)Erros ocorridos

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

caractere
Parâmetros	Descrição
pFieldName	Nome do campo

caracter

caractere que será retornado o valor
pFieldValue	Valor contido no campo solicitado
Retorno	A BO irá retornar o valor contido no campo

caracter

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

,

OUTPUT <integer>,

OUTPUT <character>

).

Descrição

Retorna

valores dos campos

o valor do campo do índice primário e único da tabela.
Parâmetros	Descrição

pcod-usuar

Código do usuário

pidi-interfacInterfacepcdn-doctoCódigo do Documentopcod-id-campo

pnum_id_docto

ID do documento

ID do campo


Retorno	A BO irá retornar o valor contido

nos campos

no campo do índice primário e único da tabela.

goToKey
Requisito	Query estar aberta.
Sintaxe	RUN goToKey IN h-handle (INPUT

<character>, INPUT

,

INPUT <integer>,

INPUT <character>

).

Descrição

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

Parâmetros

Descrição

pcod-usuar

pnum_id_docto

Código do usuário

pidi-interfacInterfacepcdn-doctoCódigo do Documentopcod-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

Informações

No tipo "Create" as seguintes validações estão sendo executadas:

campo cdn_tipo_proces → valida se o campo não está com valor = 0, se estiver, retorna msg de erro.
campo cod_chave_proces → valida se a chave do processo não está em branco, se estiver retorna msg de erro informando que o campo deve ser preenchido.
campo nom_arq_docto → valida se o nome do documento não está em branco, se estiver, retorna msg de erro informando que o campo deve ser preenchido.

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

...

Descrição

...

pi-get-next-seq
Requisito
Não há
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
get-
substituicao
next-
layouts
seq 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>
OUTPUT <pNextValue> ).
Descrição
Realiza a cópia/substituição de layouts para um usuário
Retorna um valor inteiro com o próximo ID do documento a ser criado na inclusão de registro.
Parâmetros
Tipo
Descrição
pcOrigem
CHARACTER
Código do usuário origem
pcDestinoCHARACTERCódigo do usuário destinopiOpcaoINTEGER
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 origemtt-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
iInterfaceINTEGERInterfaceiDocumentINTEGERDocumentoRetorno
pNextValue
INTEGER
ID do documento
Retorno
Valor do próximo ID do documento

OpenQuery / SetConstraint / LinkTo

Não há.

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

Tabelas Temporárias

Metodo Básico

Método Negócio

OpenQuery / SetConstraint / LinkTo

Retorna um valor inteiro com o próximo ID do documento a ser criado na inclusão de registro.
Parâmetros	Tipo	Descrição

pNextValue	INTEGER	ID do documento
Retorno	Valor do próximo ID do documento