BOArqDocto - Informação dos Documentos (Anexos)

Objetivo

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

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 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
Informações dos Arquivos
Atributo	Tipo	Formato	Descrição	Obrigatório
num_id_docto	INTEGER	999999999	Número sequencial de identificação do documento	Sim
cdn_tipo_proces	INTEGER	>>9	Tipo do processo ao qual o documento está vinculado	Sim
cod_chave_proces	CHARACTER	X(40)	Código da chave do processo	Sim
cod_usuar_docto	CHARACTER	X(12)	Código do usuário do documento	Sim
dtm_criac_docto	DATETIME	99/99/9999 HH:MM:SS.SSS	Data e hora da criação do documento	Sim
nom_arq_docto	CHARACTER	X(100)	Nome do arquivo	Sim
nom_dir_docto	CHARACTER	X(250)	Diretório onde está armazenado o documento	Sim
ind_tam_docto	CHARACTER	X(10)	Tamanho do arquivo	Não
des_docto	CHARACTER	X(200)	Descrição do Documento	Não

ttArquivoDocto
Informações dos Arquivos
Atributo	Tipo	Formato	Descrição	Obrigatório
num_id_docto	INTEGER	999999999	Número sequencial de identificação do documento	Sim
cdn_tipo_proces	INTEGER	>>9	Tipo do processo ao qual o documento está vinculado	Sim
cod_chave_proces	CHARACTER	X(40)	Código da chave do processo	Sim
cod_usuar_docto	CHARACTER	X(12)	Código do usuário do documento	Sim
dtm_criac_docto	DATETIME	99/99/9999 HH:MM:SS.SSS	Data e hora da criação do documento	Sim
nom_arq_docto	CHARACTER	X(100)	Nome do arquivo	Sim
nom_dir_docto	CHARACTER	X(250)	Diretório onde está armazenado o documento	Sim
ind_tam_docto	CHARACTER	X(10)	Tamanho do arquivo	Não
des_docto	CHARACTER	X(200)	Descrição do Documento	Não
r-rowid	ROWID		Rowid do registro	Não

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 <integer>).
Descrição	Retorna o valor do campo do índice primário e único da tabela.
	Parâmetros	Descrição
	pnum_id_docto	ID do documento
Retorno	A BO irá retornar o valor contido no campo do índice primário e único da tabela.

goToKey
Requisito	Query estar aberta.
Sintaxe	RUN goToKey IN h-handle (INPUT <integer>).
Descrição	Reposiciona registro com base no índice primário e único da tabela.
	Parâmetros	Descrição
	pnum_id_docto	Código do usuário
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 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

pi-get-next-seq
Requisito	Não há.
Sintaxe	RUN pi-get-next-seq in h-handle (OUTPUT <pNextValue> ).
Descrição	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

Não há.